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

#25169 Apps Framework README > Split out admin content to child pages #481

Merged
merged 4 commits into from
Nov 9, 2023

Conversation

Reene-Simon
Copy link
Contributor

Summary

This PR organizes the README section as per the instructions in the issue description. I have used the reviews given for a similar issue, namely the Bitbucket README and have tried to incorporate the instructions given by the reviewers. These are the main changes that have been done:

  1. Created a table of contents as mentioned
  2. Made a new admin-guide file under the docs folder
  3. Moved all configuration details into the admin-guide file
  4. Linked all the links and the table of contents according to the changes made

Ticket Link

Fixes mattermost/mattermost#25169

@mattermost-build
Copy link
Contributor

Hello @Reene-Simon,

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 Hacktoberfest hacktoberfest-accepted 2: Dev Review Requires review by a core committer 2: Editor Review Requires review by an editor labels Nov 6, 2023
@codecov-commenter
Copy link

codecov-commenter commented Nov 6, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c0be1b2) 20.11% compared to head (d09066d) 20.11%.

❗ Current head d09066d differs from pull request most recent head c49a93c. Consider uploading reports for the commit c49a93c to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #481   +/-   ##
=======================================
  Coverage   20.11%   20.11%           
=======================================
  Files          80       80           
  Lines        6628     6628           
=======================================
  Hits         1333     1333           
  Misses       5163     5163           
  Partials      132      132           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

Thanks, @Reene-Simon!

@hanzei hanzei removed the 2: Editor Review Requires review by an editor label Nov 7, 2023
Copy link
Contributor

@mickmister mickmister left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution @Reene-Simon!

Please let me know your thoughts on my comment below pertaining to moving the content around a bit

docs/admin-guide.md Outdated Show resolved Hide resolved
@Reene-Simon
Copy link
Contributor Author

@cwarnermm @mickmister I have made the requested changes. Please do review it.

README.md Outdated Show resolved Hide resolved
@mickmister mickmister removed their request for review November 9, 2023 05:56
@mickmister
Copy link
Contributor

Approving assuming the above change is done

@Reene-Simon
Copy link
Contributor Author

@cwarnermm @mickmister I have made the relevant changes. Do check it out

@cwarnermm cwarnermm added 4: Reviews Complete All reviewers have approved the pull request and removed 2: Dev Review Requires review by a core committer labels Nov 9, 2023
@cwarnermm cwarnermm enabled auto-merge (squash) November 9, 2023 14:09
@cwarnermm cwarnermm merged commit ef75cdd into mattermost:master Nov 9, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4: Reviews Complete All reviewers have approved the pull request Hacktoberfest hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Help Wanted: Apps Framework README > Split out admin content to child pages
6 participants