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

Create contributing guide for non-technical users #11

Open
ropolomx opened this issue Aug 31, 2021 · 5 comments
Open

Create contributing guide for non-technical users #11

ropolomx opened this issue Aug 31, 2021 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ropolomx
Copy link
Contributor

Create a document for non-technical members to make updates to About pages, "Wiki", etc.

@ropolomx ropolomx added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 31, 2021
@ropolomx
Copy link
Contributor Author

ropolomx commented Sep 1, 2021

Addressed by #14 submitted by @Juke34

@Juke34
Copy link
Contributor

Juke34 commented Sep 1, 2021

I would say partially addressed because I do not mention anything about Wiki. ^^

@ropolomx
Copy link
Contributor Author

ropolomx commented Sep 1, 2021

Good point. I think since the Wiki pages of the portal (which are more like catalogue) are Markdown documents, the contributing guidelines would also apply. Thanks for suggesting those guidelines,
@Juke34! Those will be a great addition.

@Juke34
Copy link
Contributor

Juke34 commented Sep 2, 2021

I understand now, yes the wiki is not really a wiki. Well we shoud at least add a Edit on GitHub sticker on top left that point to the wiki folder.
If I understand how it works we cannot see the rendering of a modification without making a proper deployment right? If it is the case I would suggest to move the doc to something like readthedocs.

@ropolomx
Copy link
Contributor Author

ropolomx commented Sep 2, 2021

I think those are excellent ideas! Thank you, @Juke34 .readthedocs is a very good suggestion, and it might work very well with the documentation of the codebase that @greysaruman is writing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants