|
|
= Documentation Hackathon =
|
|
|
[[PageOutline]]
|
|
|
|
|
|
** Monday 23 March 00:00UTC to Monday 30 March 23:59UTC 2020**
|
|
|
|
|
|
### How to participate
|
|
|
|
|
|
0. [Register](https://survey.torproject.org/index.php/726752?lang=en) to get access to create and comment on issues in Gitlab - _This is not strictly necessary for participating_
|
|
|
1. Take a look at all of the tickets marked with the "DocsHackathon" keyword on [Gitlab](https://gitlab.torproject.org/groups/web/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name=DocsHackathon)
|
|
|
2. If you have a documentation issue that is not currently reflected in [trac](https://trac.torproject.org/projects/tor/query?keywords=~docshackathon), [gitlab](https://gitlab.torproject.org/groups/web/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name=DocsHackathon) or GitHub, create it, tag it and let one of us know on [#tor-www](https://webchat.oftc.net/?channels=%23tor-www&uio=d4) so we can assign some points to it.
|
|
|
3. Choose a ticket and start working on it! You can submit PRs on GitHub or register on our Gitlab instance to submit merge requests there.
|
|
|
4. Join us on [irc](https://support.torproject.org/get-in-touch/) channel #tor-www.
|
|
|
|
|
|
A contribution will be counted when your PR or merge request is merged to the master branch of the relevant repository.
|
|
|
|
|
|
Contributions submitted outside of those times (whether or not they are eventually merged) will not count towards the contribution points total.
|
|
|
|
|
|
=== How to get started
|
|
|
|
|
|
==== Beginner
|
|
|
|
|
|
**You are good at writing but not really familiar with git**
|
|
|
|
|
|
No problem! Each page on our website has a link where you can easily submit a correction.
|
|
|
|
|
|
https://gitlab.torproject.org/web/tpo/wikis/edit-button
|
|
|
|
|
|
==== Intermediate
|
|
|
|
|
|
**You are good at writing and have some technical skills**.
|
|
|
|
|
|
https://gitlab.torproject.org/web/tpo/wikis/Compiling-a-local-version-of-the-website
|
|
|
|
|
|
==== Advanced
|
|
|
|
|
|
**You are good at writing and can find your way around code**.
|
|
|
|
|
|
https://gitlab.torproject.org/web/tpo/wikis/How-to-develop-on-the-website
|
|
|
|
|
|
### Tips to make a successful contribution
|
|
|
|
|
|
- Many self contained, well commented commits are easier to review and make it more likely for your contribution to be counted and accepted
|
|
|
- Please add a short and clear title and explanation on the commit. A commit with the title: Updates to content.lr does not say much about your intentions.
|
|
|
- What you did can be seen with the diff. Try to explain **why** you did something.
|
|
|
- Always pull before submitting a branch, because things may have changed
|
|
|
|
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
## Previous Hackathons
|
|
|
|
|
|
## 2019 edition
|
|
|
|
|
|
** Monday 2nd September 00:00UTC to Friday 6th September 23:59UTC 2019**
|
|
|
|
|
|
### How to participate
|
|
|
|
|
|
0. [Pre-register](https://survey.torproject.org/index.php/726752?lang=en) to get access to create and comment on issues in gitlab - _This is not strictly necessary for participating_
|
|
|
1. Take a look at all of the tickets marked with the "DocsHackathon" keyword on [gitlab](https://dip.torproject.org/groups/web/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name=DocsHackathon)
|
|
|
2. If you have a documentation issue that is not currently reflected in [trac](https://trac.torproject.org/projects/tor/query?keywords=~docshackathon), [gitlab](https://dip.torproject.org/groups/web/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name=DocsHackathon) or github, create it, tag it and let one of us know on [#tor-www](https://webchat.oftc.net/?channels=%23tor-www&uio=d4) so we can assign some points to it.
|
|
|
3. Choose a ticket and start working on it! You can submit PRs on github or register on our gitlab instance to submit merge requests there.
|
|
|
4. Join us on [/wiki/org/onboarding/IRC irc] channel #tor-www.
|
|
|
|
|
|
A contribution will be counted when your PR or merge request is merged to the master branch of the relevant repository.
|
|
|
|
|
|
Contributions submitted outside of those times (whether or not they are eventually merged) will not count towards the contribution points total.
|
|
|
|
|
|
### Hackathon details
|
|
|
|
|
|
Each day during the hackathon week will be dedicated to a particular website:
|
|
|
|
|
|
- Monday and Thursday: support.torproject.org
|
|
|
- GitHub: https://github.com/torproject/support
|
|
|
- gitweb: https://gitweb.torproject.org/project/web/support.git/
|
|
|
- Gitlab: https://dip.torproject.org/web/support
|
|
|
- Tuesday and Friday: tb-manual.torproject.org
|
|
|
- GitHub: https://github.com/torproject/manual
|
|
|
- gitweb: https://gitweb.torproject.org/project/web/manual.git/
|
|
|
- Gitlab: https://dip.torproject.org/web/manual
|
|
|
- Wednesday and Friday: www.torproject.org
|
|
|
- GitHub: https://github.com/torproject/tpo
|
|
|
- gitweb: https://gitweb.torproject.org/project/web/tpo.git/
|
|
|
- Gitlab: https://dip.torproject.org/web/tpo
|
|
|
|
|
|
|
|
|
We're going to award Tor T-shirts to the top 3 contributors and there’ll be a few other prizes for special contributions during the week.
|
|
|
|
|
|
At the end of the week we will tally up all contributions and points (harder tasks award more points!) and award prizes to the top 3 contributors for the week. There may also be additional prizes for exceptional contributions throughout the week.
|
|
|
|
|
|
## How to get started
|
|
|
|
|
|
=== Beginner ===
|
|
|
|
|
|
**You are good at writing but not really familiar with git**
|
|
|
|
|
|
No problem! Each page on our website has a link where you can easily submit a correction.
|
|
|
|
|
|
https://dip.torproject.org/web/tpo/wikis/edit-button
|
|
|
|
|
|
=== Intermediate ===
|
|
|
|
|
|
**You are good at writing and have some technical skills**.
|
|
|
|
|
|
https://dip.torproject.org/web/tpo/wikis/Compiling-a-local-version-of-the-website
|
|
|
|
|
|
=== Advanced===
|
|
|
|
|
|
**You are good at writing and can find your way around code**.
|
|
|
|
|
|
https://dip.torproject.org/web/tpo/wikis/How-to-develop-on-the-website
|
|
|
|
|
|
## Tips to make a successful contribution
|
|
|
|
|
|
- Many self contained, well commented commits are easier to review and make it more likely for your contribution to be counted and accepted
|
|
|
- Please add a short and clear title and explanation on the commit. A commit with the title: Updates to content.lr does not say much about your intentions.
|
|
|
- What you did can be seen with the diff. Try to explain **why** you did something.
|
|
|
- Always pull before submitting a branch, because things may have changed
|
|
|
-
|
|
|
## FAQ
|
|
|
|
|
|
=== What happens if there is an issue that I’ve identified but there is no existing ticket for it? ===
|
|
|
|
|
|
Please create the ticket and let one of us know on #tor-www. One of our team will take a look and assign a number of points to it You can create the ticket
|
|
|
|