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

[GH-1105] - WIP - Documentation style guide revision #1196

Merged
merged 8 commits into from Apr 5, 2023
Merged

[GH-1105] - WIP - Documentation style guide revision #1196

merged 8 commits into from Apr 5, 2023

Conversation

ghost
Copy link

@ghost ghost commented Mar 31, 2023

Summary

This PR is for revisions to the Documentation style guide in the technical writing section of the handbook. It is a WIP, any feedback is welcome. So far this PR:

  • Moves RST and MD content to new pages
  • Re-orders the style guide sections
  • Removed a few passages that seemed unnecessary

This is related to #1105.

@mattermost-build
Copy link

Hello @matthew-src,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

@cwarnermm cwarnermm added the 2: Editor Review Requires review by an editor label Mar 31, 2023
@justinegeffen
Copy link
Contributor

This is awesome, Matthew! The handbook doesn't have a preview build so we just merge and iterate as needed. This looks great to me - let me know if you want to merge to see the changes or if you work locally and are using local builds to track.

@ghost
Copy link
Author

ghost commented Mar 31, 2023

Thank you @justinegeffen. I am still working on this, so please wait to merge.

cwarnermm
cwarnermm previously approved these changes Apr 3, 2023
Copy link
Member

@cwarnermm cwarnermm left a comment

Choose a reason for hiding this comment

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

Thank you, @matthew-src!

@ghost
Copy link
Author

ghost commented Apr 5, 2023

Hi @justinegeffen and @cwarnermm, I made a few more edits to the guide, and added the new pages for RST and MD to the SUMMARY.md page. I hope this means that they will appear in the navigation bar of the Gitbook. Feel free to merge this now to see the changes.

@justinegeffen justinegeffen added 3: Reviews Complete All reviewers have approved the pull request and removed 2: Editor Review Requires review by an editor labels Apr 5, 2023
@justinegeffen justinegeffen merged commit 2ca50a3 into mattermost:0.2.1 Apr 5, 2023
justinegeffen added a commit that referenced this pull request Apr 5, 2023
@justinegeffen
Copy link
Contributor

@matthew-src, I'm so sorry - I merged this before reviewing it thoroughly and noticed some changes that I wanted to query so I've reverted the changes which means they need to be redone. I'm going to redo them on my side as I messed up. I did have some questions about the content that was removed but will raise them in the new PR.

Sorry about this; I know this wasn't a quick one to put together.

@ghost
Copy link
Author

ghost commented Apr 5, 2023

No problem!

@justinegeffen
Copy link
Contributor

In terms of an ETA, I'll aim to get this redone by Friday. Thanks for understanding! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3: Reviews Complete All reviewers have approved the pull request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants