-
Notifications
You must be signed in to change notification settings - Fork 38
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
Add 'how to contribute' content + styleguide #228
Comments
Hi @RCheesley, can you give more explanation on what this issue is about? And how I would go about it if I were allowed to contribute to this. |
Hi @Timonwa and thanks for being willing to help out! Apologies for the brevity of the description! Currently on the user documentation, we don't have anything telling people how to contribute to the documentation. We used to have a style guide and a contributing page. My thoughts out loud were that perhaps we should have those docs in the Community Handbook (https://contribute.mautic.org) rather than on the docs itself, and simply link out to those resources. The repo for the Community Handbook is here: https://github.com/mautic/mautic-community-handbook. So what I suggest is:
Hope that makes sense, @mautic/education-team-leaders might chime in if they have some further thoughts! |
Thank you, @RCheesley. This makes more sense now. I can work on this. However, I might need help knowing what information to update or remove. I could figure some out while contributing to or moving the documents, but I still need help ensuring all the details are current.
Let me know your thoughts. |
Handing this over to @mautic/education-team-leaders who can give you a steer on this! |
Thank you for reaching out and for your willingness to contribute to the improvement of our documentation for Mautic. Regarding your points:
@RCheesley @fakela, if you have any additional suggestions on how we can further enhance this, please feel free to share them. |
Hi @favour-chibueze, thanks for your comment and clarification. I can go ahead and work on the pages now. |
Sure, you can reach out if you need help. |
This used to be on the docs, but maybe it sits better in the Community handbook (contribute.mautic.org)?
Either way, we should have it loud and proud on the landing page, how to contribute!
Note for redirects:
https://docs.mautic.org/en/contributing/style-guide
https://docs.mautic.org/en/contributing
The text was updated successfully, but these errors were encountered: