Update Readme, add link to addons manual page #573
Conversation
NikosAlexandris
commented
Jun 28, 2021
NikosAlexandris
commented
- restructure Readme
- add link to addons manual page
|
I changed the base branch. The default base branch is still master branch, so that's what PRs default to. We need to make the decision about 7.8.6 and change of default branch now. Please contribute on grass-dev. |
| must be requested, see here for details: | ||
| <https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository> | ||
|
|
||
| However, it is also possible to fork this repository, insert your AddOn or fix |
There was a problem hiding this comment.
we should decide how to write addons: AddOns, add-ons, addons, etc?
There was a problem hiding this comment.
Was this ever decided elsewhere? For now, here it seems lowercase, one word, « addons » is used d’or talking about the repo, and « addon » for when talking for a single one.
Does this align with the user interface inside the software?
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
Co-authored-by: Veronica Andreo <[email protected]>
| Read access is granted to the public, write access | ||
| must be requested, see here for details: | ||
| <https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository> |
There was a problem hiding this comment.
This is really awkward given the current state of art. The fork & read the contributing file route should be the primary or only way mentioned. The write access, i.e., becoming sort of a co-maintainer, should be mentioned second or in the contributing file.
|
|
||
| ## How to get write access here | ||
| This is the official GRASS GIS Addons git repository. |
There was a problem hiding this comment.
"git repository" sounds like there is some other one. Well, maybe there is (binaries for Windows), but is that relevant here? In any case, Git should be capitalized (the software uses first upper case when it is not the command line tool name).
|
Now, this needs to target grass8 branch, so I changed the base branch in the PR. Making changes will re-trigger the required checks. If not, rebase to/merge with the grass8 branch to bring in the latest checks as well as any v8-related updated which happened in the readme. |
| @@ -71,7 +81,7 @@ MODULE_TOPDIR to where to the GRASS binaries are located: | |||
| make MODULE_TOPDIR=/usr/lib/grass78/ | |||
| ``` | |||
|
|
|||
| ## How to submit contributions | |||
| ### Contribute | |||
There was a problem hiding this comment.
This could be changed to "Submiting guidelines" or so...
There was a problem hiding this comment.
We should probably stick to How to contribute or Contributing [guidelines] and leave out these pieces from the readme. GitHub calls it Contributing in Insights > Community and it is supposed to be centered around a CONTRIBUTING.md file which we already have.
There was a problem hiding this comment.
Do you suggest then to remove this section from README.md completely, and move whatever is down here to CONTRIBUTING.md? If yes, it sounds reasonable to me. Moreover, the submitting link is also in SUBMITTING.md. So, we could just link to both files and done. I can create a new PR from scratch with all suggestions here.
There was a problem hiding this comment.
Sounds good.
Perhaps, you can remove SUBMITTING. The word for it now is contributing and we have CONTRIBUTING.md. Will anyone look for a file called SUBMITTING and ignore file called CONTRIBUTING.md? Or is there an automated system which uses that? Probably not.
|
|
||
| ``` | ||
| git clone https://github.com/OSGeo/grass-addons.git grass_addons | ||
| ``` | ||
|
|
||
| ## How to install or remove AddOns in your GRASS installation | ||
| ### Write access |
There was a problem hiding this comment.
What about changing this to Contributing? Then, adding a paragraph like (compiled/adapted according to comments):
Contributing to GRASS GIS addons repository is really simple. Just fork the repo and make a pull request. We welcome fixes, enhancements and new addons.
If you would like to become a mantainer, you can request for write access. See here for details.
In either case, please read the submitting rules at the bottom of this page.
| However, it is also possible to fork this repository, insert your AddOn or fix | ||
| an existing one in a new branch and finally open | ||
| a [pull request](https://help.github.com/en/articles/about-pull-requests). | ||
| The simplest way to install GRASS GIS Addons is to use the `g.extension` |
There was a problem hiding this comment.
| The simplest way to install GRASS GIS Addons is to use the `g.extension` | |
| The simplest way to install GRASS GIS addons is to use the `g.extension` |
| Read access is granted to the public, write access | ||
| must be requested, see here for details: | ||
| <https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository> | ||
| ## Install AddOns |
There was a problem hiding this comment.
| ## Install AddOns | |
| ## Install addons |
| Head over to [GRASS GIS 7 Addons Manual | ||
| pages](https://grass.osgeo.org/grass78/manuals/addons/) |
There was a problem hiding this comment.
| Head over to [GRASS GIS 7 Addons Manual | |
| pages](https://grass.osgeo.org/grass78/manuals/addons/) | |
| Head over to [GRASS GIS 8 addons Manual | |
| pages](https://grass.osgeo.org/grass80/manuals/addons/) |
|
|
||
| ## How to get write access here | ||
| This is the official GRASS GIS Addons git repository. |
There was a problem hiding this comment.
| This is the official GRASS GIS Addons git repository. | |
| This is the official GRASS GIS addons repository. |
| @@ -1,34 +1,44 @@ | |||
| # GRASS Addons git repository | |||
| # GRASS GIS Addons | |||
There was a problem hiding this comment.
| # GRASS GIS Addons | |
| # GRASS GIS addons |
|
@NikosAlexandris Do you see a chance to complete this PR? Thanks! |
|
@NikosAlexandris Can you please rebase this PR on top of the current |
