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

Converting community-wide-resources to rst #230

Merged
merged 42 commits into from
Oct 22, 2024

Conversation

Iqmaa
Copy link
Contributor

@Iqmaa Iqmaa commented Oct 6, 2024

fixed #221
I have been able to convert 'community wide resources' to rst format, excluding the page's metadata

@Iqmaa Iqmaa changed the title Converting to rst Converting community-wide-resources to rst Oct 7, 2024
Iqmaa added 2 commits October 7, 2024 14:46
name correction of community-wide-resources
correcting error prevet-prevent
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.

Hey there! Thanks for making a great start on this!

A few things that you need to factor into this PR before we can merge - these are all documented in the issue - please take the time to read it:

  1. Please follow our headings syntax, as outlined in the issue description. We don't use over and under headings, only under.
  2. Please don't touch the .revs folder - if anything they should be deleted. It's the old version control system Grav used, and not the live files.
  3. You've generated link files but you're not using them properly, please check the docs here: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#use-the-external-links-extension
  4. We don't need to use random lines like you've done in the async meetings file on line 5 - they don't serve a purpose, so you can remove them.
  5. Please check that all links are using the link macro, e.g. on line 59 of the same file there's a link posted.
  6. Please use ref: or doc: to link to other pages.
  7. Please use the image markup here: https://sublime-and-sphinx-guide.readthedocs.io/en/latest/images.html#add-images rather than figure.

Let me know if you are stuck with anything!

IqmaCodes and others added 3 commits October 8, 2024 20:06
checking appropriate linking method
return to original format
@Iqmaa
Copy link
Contributor Author

Iqmaa commented Oct 8, 2024

Hey @RCheesley, sorry for that.
I have:

  1. Fixed the headings issue
  2. Converted the .rev files back to original form
  3. removed unnecessary lines
  4. replaced the figure with the image markup, and
  5. Fix the linking issue

Please review when you can

@Iqmaa Iqmaa requested a review from RCheesley October 13, 2024 13:17
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.

A few changes but mostly the same things:

  • Not using camel case in headings
  • A file not required
  • A missed link macro

I will make a commit to move all the files to the right folder so you don't need to worry about that, and will also write some half-decent onboarding docs on how to write for the docs as I appreciate this is somewhat lacking!

Iqmaa and others added 6 commits October 22, 2024 00:08
…repare-and-run-a-mautic-team-meeting/docs.rst

Co-authored-by: Ruth Cheesley <[email protected]>
…repare-and-run-a-mautic-team-meeting/docs.rst

Co-authored-by: Ruth Cheesley <[email protected]>
…repare-and-run-a-mautic-team-meeting/docs.rst

Co-authored-by: Ruth Cheesley <[email protected]>
…repare-and-run-a-mautic-team-meeting/docs.rst

Co-authored-by: Ruth Cheesley <[email protected]>
…repare-and-run-a-mautic-team-meeting/docs.rst

Co-authored-by: Ruth Cheesley <[email protected]>
corrected heading issue
@RCheesley
Copy link
Member

LMK when you're done @Iqmaa if you'd like me to fix the RST issues/move the directories!

@Iqmaa Iqmaa requested a review from RCheesley October 21, 2024 23:23
@RCheesley
Copy link
Member

OK Vale is now happy (I have checked it locally, as the linter is having a problem which I'll try to fix in another PR) - the build is now passing. LGTM! Thanks so much for getting this underway @Iqmaa and for your patience! 🚀

@RCheesley RCheesley merged commit 958ce0f into mautic:main Oct 22, 2024
1 of 2 checks passed
Copy link

holopin-bot bot commented Oct 22, 2024

Congratulations @Iqmaa, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cm2jppvus101970clbs8yh3l98

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

@Iqmaa
Copy link
Contributor Author

Iqmaa commented Oct 22, 2024

I'm really grateful for your patience and help @RCheesley, I learnt quite a lot from contributing to this.
Thanks again !

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 the community-wide resources section to RST
2 participants