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

Converted Community team section to RST #223 #232

Closed
wants to merge 2 commits into from

Conversation

HappySR
Copy link

@HappySR HappySR commented Oct 6, 2024

Converted Community team section to RST format while adhering to Vale Grammar. Fixes #223

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @HappySR and thanks for making a start on this!

Some of the files you've changed revision files (indicated by .revs in the file path) rather than the actual file - these files are used for version control in Grav. In fact, they really should be deleted all together! I'm sorry I hadn't noticed this and given you a heads up accordingly.

For clarity, this PR requires you to convert only the file pages/09.community-team/chapter.md, and the individual docs.md files (NOT the .revs/* files) within 01.community-dashboard and 02.meetup-guidelines and in converting, you need to move it into the /docs folder, and add it to the index.

I would recommend that we create a folder structure which maps to the menu structure on the community handbook at this time - so I'd make a folder called teams, and then within that make the community-team.rst file. Then you can make a separate rst file for the community dashboard, and for the meetup guidelines.

To add this to the Read the Docs menu, we'd need then to add it to the docs/index.rst file: https://github.com/mautic/mautic-community-handbook/blob/main/docs/index.rst. You can read more about the ToC and what it all means here: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/indices.html. For an example of how we use this in the main docs, check this file: https://github.com/mautic/user-documentation/blob/5.x/docs/index.rst.

If you want to run this locally to see how it comes out, the way I do it is to follow the steps in the readme here: https://github.com/mautic/user-documentation/tree/5.x?tab=readme-ov-file#build-documentation-locally by cloning the repository and then in the docs folder, I do ddev configure (using build/html as the root folder) followed by ddev start but this might be a challenge if you aren't familiar with working with a local tech stack.

Let me know if you need help with any of this - I'll add some more instructions on the other related issues in case this trips others up!

@HappySR HappySR closed this Oct 16, 2024
@HappySR HappySR deleted the Community-to-RST branch October 16, 2024 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert Community Team section to RST
3 participants