Skip to content
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

Improves Contributing section #85

Merged
merged 4 commits into from
Mar 9, 2022
Merged
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
5 changes: 3 additions & 2 deletions en/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
*** xref:customize:texts.adoc[Texts]
*** xref:customize:users_registration_mode.adoc[User registration mode]
*** xref:customize:views.adoc[Views]
** xref:configure:services:index.adoc[Services]
** xref:services:index.adoc[Services]
*** xref:services:activejob.adoc[Active Job]
*** xref:services:elections_bulletin_board.adoc[Elections Bulletin Board]
*** xref:services:etherpad.adoc[Etherpad]
Expand Down Expand Up @@ -140,8 +140,9 @@
*** xref:admin:information-pages.adoc[Information pages]

* xref:contribute:index.adoc[Contribute]
** xref:ROOT:governance.adoc[Governance]
** xref:contribute:governance.adoc[Governance]
** xref:contribute:translations.adoc[Translations]
** xref:contribute:documentation.adoc[Documentation]

* xref:develop:index.adoc[Develop]
** xref:develop:guide.adoc[Guide]
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions en/modules/contribute/pages/documentation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
= Documentation

To contribute to the documentation (for instance, this same page that you're reading), you can do it through two ways: editing on GitHub directly or editing locally.

== Edit on GitHub

This is the recomended way if you just want to make a quick fix (for instance, a typo or some clarification on a single page). For doing this you'll need to click in the "Edit this page" link in the top of every page.

image::documentation-edit.png[Edit this page link]

It'll open the page for editing in GitHub interface and after you've finished it'll guide you to make a Pull Request so maintainers can review your contribution.

== Edit locally

If you want to propose lots of changes in the documentation, or if you want to review your changes locally before sending them because you want to review things like formatting, you can install the environment for having the documentation site locally.

Then you'll need to fork the repository, make a branch and propose your changes as a Pull Request so maintainers can review it. As you see this can be a hassle if you want to make small changes, so the prefered way would be to do it initially with the "Edit this page" link mehod.

Read the full instructions on how to install this documentation website locally in the https://github.com/decidim/documentation/[Decidim Documentation GitHub repository].
10 changes: 10 additions & 0 deletions en/modules/contribute/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
= Contribute

You don't need to know how to code to contribute to Decidim, just having available time and attitude.

Learn more about https://github.com/decidim/decidim/blob/develop/CONTRIBUTING.adoc[How to contribute to Decidim] in GitHub.

* xref:contribute:governance.adoc[Governance]
* xref:contribute:translations.adoc[Translations]
* xref:contribute:documentation.adoc[Documentation]