Update Readme, add link to addons manual page by NikosAlexandris · Pull Request #573 · OSGeo/grass-addons

NikosAlexandris · 2021-06-28T12:22:02Z

restructure Readme
add link to addons manual page

wenzeslaus · 2021-06-28T13:32:26Z

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.

README.md

veroandreo · 2021-06-28T14:56:54Z

README.md

+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


we should decide how to write addons: AddOns, add-ons, addons, etc?

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?

Some more decision here #929

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>

wenzeslaus

Thanks. This is much needed. I think you should go further or just remove some strange parts. See comments.

wenzeslaus · 2021-06-28T18:43:28Z

README.md

+Read access is granted to the public, write access
+must be requested, see here for details:
+<https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository>


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.

wenzeslaus · 2021-06-28T18:45:37Z

README.md

+# GRASS GIS Addons

-## How to get write access here
+This is the official GRASS GIS Addons git repository.


"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).

wenzeslaus · 2021-12-08T20:16:27Z

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.

veroandreo

I took the liberty to homogenize to addons and made some suggestions on re-structuring/re-writing

veroandreo · 2022-01-13T15:39:12Z

README.md

 ```

-## How to submit contributions
+### Contribute


This could be changed to "Submiting guidelines" or so...

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.

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.

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.

veroandreo · 2022-01-13T15:39:23Z

README.md

 ```

-## How to install or remove AddOns in your GRASS installation
+### Write access


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.

veroandreo · 2022-01-13T15:39:30Z

README.md

-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`


Suggested change

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`

veroandreo · 2022-01-13T15:39:34Z

README.md

-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


Suggested change

## Install AddOns

## Install addons

veroandreo · 2022-01-13T15:39:38Z

README.md

+Head over to [GRASS GIS 7 Addons Manual
+pages](https://grass.osgeo.org/grass78/manuals/addons/)


Suggested change

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/)

veroandreo · 2022-01-13T15:39:42Z

README.md

+# GRASS GIS Addons

-## How to get write access here
+This is the official GRASS GIS Addons git repository.


Suggested change

This is the official GRASS GIS Addons git repository.

This is the official GRASS GIS addons repository.

veroandreo · 2022-01-13T15:39:46Z

README.md

@@ -1,34 +1,44 @@
-# GRASS Addons git repository
+# GRASS GIS Addons


Suggested change

# GRASS GIS Addons

# GRASS GIS addons

neteler · 2022-04-24T14:40:19Z

@NikosAlexandris Do you see a chance to complete this PR? Thanks!

neteler · 2022-10-03T08:40:39Z

@NikosAlexandris Can you please rebase this PR on top of the current README.md (see also #785)?

NikosAlexandris added 4 commits June 28, 2021 15:18

Re-title the README.md, add link to addons overview manual page

c2d283b

Move install instructions in separate sub-section

065df70

Re-section the README.md, shorten sub-section titles

e7d01ed

Move 'write access' related content under ### Write access

cd2db00

NikosAlexandris mentioned this pull request Jun 28, 2021

List of add-ons in the repository #572

Open

wenzeslaus changed the base branch from master to grass7 June 28, 2021 13:29

veroandreo reviewed Jun 28, 2021

View reviewed changes

NikosAlexandris and others added 4 commits June 28, 2021 17:52

Update README.md

50b9581

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>

Update README.md

34728dd

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>

Update README.md

8ec8359

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>

Update README.md

534860a

Co-authored-by: Veronica Andreo <veroandreo@gmail.com>

wenzeslaus requested changes Jun 28, 2021

View reviewed changes

wenzeslaus changed the base branch from grass7 to grass8 December 8, 2021 20:12

veroandreo reviewed Jan 13, 2022

View reviewed changes

	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`

		Head over to [GRASS GIS 7 Addons Manual
		pages](https://grass.osgeo.org/grass78/manuals/addons/)

	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

Comments

Conversation

NikosAlexandris commented Jun 28, 2021

Uh oh!

wenzeslaus commented Jun 28, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wenzeslaus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wenzeslaus commented Dec 8, 2021

Uh oh!

veroandreo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neteler commented Apr 24, 2022

Uh oh!

neteler commented Oct 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants