Skip to content

Update html heading structure #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions _i18n/en/contribute/develop.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
As a community project, AntennaPod relies on voluntary code contributions from a wide range of people. Not just for the app itself, but also the website and related projects.

# 1. App (Java)
## 1. App (Java)
You're right at it: the core of the project! Used by thousands of people across the world, your contributions are an important contribution to an open podcasting ecosystem. So, are you experienced with Java, or just getting started? We welcome your contributions in our [GitHub repository](https://github.com/AntennaPod/AntennaPod).

## Where we need help
### Where we need help
There's a few areas where we could well use your support. Because they're important, often-requested, or both. We've set up a clear overview of [the issues and feature areas we most need help with](https://github.com/AntennaPod/AntennaPod/projects/2). Get yourself into any of the following issues and we'll add you to our (mental) list for eternal gratitude!

Apart from these major projects, you can always check out the [issues with the 'help wanted' label](https://github.com/AntennaPod/AntennaPod/labels/help%20wanted) on GitHub.

If you prefer bug-hunting, your go-to list for a weekend bug-hunt is the ['confirmed bugs' issue label](https://github.com/AntennaPod/AntennaPod/labels/Type%3A%20Confirmed%20bug) on GitHub.

## Getting started
### Getting started
**Before** Please don't just submit a PR, but always *announce your interest first*. Sometimes we didn't yet reach an agreement on a user experience and interface. It can happen that someone agreed to start working on something, but we forgot to 'assign' the GitHub issue. Chipping in on our forum is the best way to avoid lost hours on code that won't be accepted.

**During** Have a look at our wiki; it contains [handy info for contributors](https://github.com/AntennaPod/AntennaPod/wiki). You'll find there, for example, information about the project's [code style](https://github.com/AntennaPod/AntennaPod/wiki/Code-style) and can learn [how to make sure you get accredited](https://github.com/AntennaPod/AntennaPod/wiki/Getting-accredited-on-the-Contributors-page) for your work in the app. Last but not least: build instructions and info about debug logs.

**After** Talk about your work, and claim that fame! It might inspire other potential contributors, and helps promote the app generally. We're happy to retweet your tweets!

# 2. Website (SCSS, HTML)
## 2. Website (SCSS, HTML)
The base of our new website was kindly built by [Anxhelo](https://lushka.al). Now we're ready to expand! Are you familiar with [Jekyll](https://jekyllrb.com/)? Then help us implement (parts of) [our website wishlist](https://forum.antennapod.org/t/sitemap-for-the-new-website/240) and check out our [website repository](https://github.com/AntennaPod/antennapod.github.io) now.

# 3. Upstream & other projects
## 3. Upstream & other projects
AntennaPod doesn't live in isolation. The project relies on many others - contributing to those means helping AntennaPod thrive:
* **Nextcloud Podcast app** (Vue, PHP, Javascript)
December 2020 Jonas Heinrich created the [Nextcloud Podcast app](https://apps.nextcloud.com/apps/podcast). It already is a great way to subscribe and listen to your podcasts online, in a self-hosted environment. Its further development and [integration with AntennaPod](https://git.project-insanity.org/onny/nextcloud-app-podcast/-/issues/103) would be a very welcome addition.
* **gpodder.net** (Python, HTML)
The long-standing and libre [gpodder.net](https://gpodder.net/) project allows users to connect and synchronise their podcast players. Unfortunately the project is a victim of its own success: the webserver often being unavailable and AntennaPod users see sync errors. Any support to the project and its maintainers is welcome, in particular with [this API issue](https://github.com/gpodder/mygpo/issues/128).

# Get in touch!
## Get in touch!
Vaguely interested but not sure yet? Ready to get started? Get in touch with @Keunes or @ByteHamster on [our forum](https://forum.antennapod.org)!
2 changes: 1 addition & 1 deletion _i18n/en/contribute/promote.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ Feeling comfortable with (digital) pen & ink? Then help us spice up our website,
* **Everything else**
Do you have other great ideas to promote the project? Get in touch and share them with us.

# Get in touch
## Get in touch
Vaguely interested but not sure yet? Ready to get started? Get in touch with [@Keunes on our forum](https://forum.antennapod.org/u/keunes)! To get an idea of our current materials, you can also check out [our Twitter feed](https://www.twitter.com/antennapod), [our blog](/blog) and the [Branding repository](https://github.com/AntennaPod/Branding) on GitHub.
8 changes: 4 additions & 4 deletions _i18n/en/contribute/translate.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Out of the estimated [world population](https://en.wikipedia.org/wiki/World_popu

We therefore much appreciate your help!

# The app
## The app
To help translate the app, we ask you to contribute via [Transifex](https://www.transifex.com/antennapod/antennapod/). Anyone can sign up there and get started. Transifex has helpful guides to [get started on their platform](https://docs.transifex.com/getting-started-1/translators) and to [get familiar with the Web Editor interface](https://docs.transifex.com/translation/translating-with-the-web-editor).

Under the AntennaPod project you will find three 'resources':
Expand All @@ -47,7 +47,7 @@ New translations are pulled from Transifex to GitHub (the development platform)

Translation contributors will find themselves mentioned in the app with their Transifex username, under `Settings` » `About` » `Contributors`.

# The website
## The website
For several reasons (outlined in a [blogpost on website translations](/blog/2022/01/website-translations)) we use a different translation system for our website: [Weblate](https://hosted.weblate.org/projects/antennapod/). Anyone can sign up there and start contributing. In Weblate's documentation you'll find [everything you need to know to start translating](https://docs.weblate.org/en/latest/user/translating.html).

In the AntennaPod project, you will find four 'components'. Each represents a part of the website. We encourage you to start with the components `General` and the `Short strings`, because these will be the first elements a user sees on the website. The component `Documentation` is a very close second priority, because this section is directly available via the app when people tap on Support. The `Contribute` component comes last, because a basic understanding of English is needed anyway to interact with the community.
Expand All @@ -57,10 +57,10 @@ In the AntennaPod project, you will find four 'components'. Each represents a pa

New translations are pulled from Weblate to GitHub (the development platform) manually once in a while. When a language hits 90% translation (that's roughly the whole website minus the Contribute section), we can enable it on the live website. We always try to find a community member that can review a test version of the website, to improve the quality of translations.

# Other materials
## Other materials
In addition to the app and website, also the images in the app stores can be translated. They have screenshots and texts. Because there is very limited space we use a manual process with trial and error. Please let us know on the forum if you want to help with that. Because localized app store listings are more likely to be downloaded, help is very much welcome!

# Get in touch!
## Get in touch!
* Do you want to give **feedback** on the English texts or any of the translations?
* Are you **interested in helping** with translations but not sure yet? Or you are ready to get started?
* Do you (want to) contribute and **need support**? For example, because your language isn't available yet, or because you are not sure how to translate something?
Expand Down