kompot
/
publiccode.si
5
3
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

make instructions clearer

lektura
max.mehl 2017-09-08 12:07:54 +02:00
parent f9f31cf887
commit f67904c6ec
2 changed files with 43 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -54,7 +54,7 @@ relevant for our build process (Drone, Ansible, Docker, Apache).
Visit [TRANSLATE.md](https://git.fsfe.org/pmpc/website/src/master/TRANSLATE.md)
for detailed instructions how to translate publiccode.eu.
### Build locally
### Build
To see a preview of the website you need to have Hugo installed and be able to
execute Bash scripts in your command line.
@ -70,17 +70,28 @@ execute Bash scripts in your command line.
computer only. Open [localhost:1313](localhost:1313) in your web
browser to see it.
If you want to make changes to the official website, please read [our
Git guides](https://wiki.fsfe.org/TechDocs/Git). There you'll find out
about the necessary commands pull, status, add, commit, or push.
If you want to make changes to the official website, please read [our
Git guides](https://wiki.fsfe.org/TechDocs/Git). There you'll find out
about the necessary commands `pull`, `status`, `add`, `commit`, and
`push`.
Beginners can directly commit to the repository which saves them some
steps, but they have to ask @max.mehl or @jonas in advance to give them
the necessary permission. For more experienced Git users we recommend
the Fork & Pull Request workflow, which you'll also find in the [wiki's
Git Guides
section](https://wiki.fsfe.org/TechDocs/Git#Guides_on_specific_actions)
(not available yet).
There are three ways to upload/edit files in the Git repository, sorted
by preference and complexity:
1. For more experienced Git users we recommend the Fork & Pull Request
workflow, which you'll also find in the [wiki's Git Guides
section](https://wiki.fsfe.org/TechDocs/Git#Guides_on_specific_actions)
(not available yet).
2. Advanced and interested beginners can directly commit to the
repository ("push to master") which saves them some steps, but they
have to ask @max.mehl or @jonas in advance to give them the necessary
permissions. You'll find guides in the [Wiki's Git
section](https://wiki.fsfe.org/TechDocs/Git#Guides_on_specific_actions).
3. Beginners can work directly in the [web
interface](https://git.fsfe.org/pmpc/website) of git.fsfe.org. As
soon as you have given write permissions by @max.mehl or @jonas, you
can edit opened text files and upload/create new files. This is the
least preferred option because it may cause conflicts, but it is easy
and may give you some first experience with the system.
## Important file paths

30
TRANSLATE.md
View File

@ -15,7 +15,10 @@ to be a programmer to get Git working for you :)
What you should have:
- An account on git.fsfe.org
- Know how to clone, pull, commit, and push with Git (read the [general Git guides](https://wiki.fsfe.org/TechDocs/Git) and/or the [typical Git workflow](https://wiki.fsfe.org/TechDocs/Mainpage/Editing#Edit_and_push_files_to_the_website))
- Know how to clone, pull, commit, and push with Git (read the [general
Git guides](https://wiki.fsfe.org/TechDocs/Git) and/or the [typical
Git
workflow](https://wiki.fsfe.org/TechDocs/Mainpage/Editing#Edit_and_push_files_to_the_website))
- Optional: Hugo installed on your computer
- Optional: The ability to run Bash scripts from command line
@ -78,16 +81,25 @@ logos, and other communication is using this brand. So if you can, just stick
to the English term.
## Finished? What's next
## Where to upload the translations?
Before submitting the translations you can test them locally if you have Hugo
installed and are able to execute Bash scripts on your command line. Please
refer to README.me for instructions.
**Before submitting** the translations you can test them locally if you
have Hugo installed and are able to execute Bash scripts on your command
line. Please refer to [build section in
README.me](https://git.fsfe.org/pmpc/website/src/master/README.md#build)
for instructions.
You're welcome to work with the Git repository to upload your translations. If
you feel confident enough with Git, please open a pull request of a separate
branch in this repository or your fork. @max.mehl can help you if you have
questions or lack permissions.
You're welcome to work with the Git repository to upload your
translations. If you feel confident enough with Git, please open a pull
request of a separate branch in this repository or your fork. @max.mehl
can help you if you have questions or lack permissions.
For Git, there are three ways which are explained in the aforementioned
build README section:
1. Git Pull Requests from your repository forks
2. Git pushes to the central master branch (requires write access)
3. Edit the files directly in the git.fsfe.org web interface (requires
write access)
If you are unsure, you can also send the translations to [FSFE's translators
list](https://lists.fsfe.org/mailman/listinfo/translators) to let them