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.

Sign up for GitHub

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

Jump to bottom

Help Wanted: BitBucket README > Split out admin content to child pages #25176

Open
mattermod opened this issue Oct 26, 2023 · 3 comments · May be fixed by mattermost-community/mattermost-plugin-bitbucket#125
Open

Help Wanted: BitBucket README > Split out admin content to child pages #25176

mattermod opened this issue Oct 26, 2023 · 3 comments · May be fixed by mattermost-community/mattermost-plugin-bitbucket#125
Assignees
@kat-kan
Labels
Difficulty/1:Easy Easy ticket Good First Issue Suitable for first-time contributors Hacktoberfest Help Wanted Community help wanted Tech/Markdown

Comments

@mattermod
Copy link
Contributor

mattermod commented Oct 26, 2023 •
edited by cwarnermm
Loading

Mattermost GitHub Repository: https://github.com/mattermost/mattermost-plugin-bitbucket

Update the plugin README content to match the outline below, where possible.

Task list

  • Organize README content based on the outline above. Add section headings if they’re applicable but missing.
  • Add a simple table of contents (titles only) to the top of the README with links to each section/page.
  • Move the admin setup/config content from the README page to a new child GitHub page within /docs. Ensure the table of contents link points to the new child page.
  • Move all existing guide images in the README from the /assets directory to /docs/images directory & relink images.
  • Verify that all moved content & links are accessible as expected.

If you're interested please comment here and come join our "Contributors" community channel on our daily build server, where you can discuss questions with community members and the Mattermost core team. For technical advice or questions, please join the DWG: Documentation Working Group channel on the Mattermost Community Server.

New contributors please see our Developer's Guide.

JIRA: https://mattermost.atlassian.net/browse/MM-55077
@kat-kan
Copy link

kat-kan commented Oct 26, 2023

I'd like to work on that issue.

@cwarnermm cwarnermm added Difficulty/1:Easy Easy ticket Good First Issue Suitable for first-time contributors Tech/Markdown labels Oct 26, 2023
@cwarnermm
Copy link
Member

Thanks, @kat-kan! Reach out via the DWG: Documentation Working Group channel on the Mattermost Community Server any time to discuss further.

@cwarnermm cwarnermm mentioned this issue Oct 26, 2023
Closed
@cwarnermm cwarnermm changed the title BitBucket README: Split out admin content to child pages Help Wanted: BitBucket README > Split out admin content to child pages Oct 26, 2023
@kat-kan kat-kan linked a pull request Oct 26, 2023 that will close this issue
Open
@kat-kan
Copy link

kat-kan commented Oct 26, 2023

I've attached screenshots for README and admin-guide new outline in PR mattermost-community/mattermost-plugin-bitbucket#125

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kat-kan kat-kan

Labels
Difficulty/1:Easy Easy ticket Good First Issue Suitable for first-time contributors Hacktoberfest Help Wanted Community help wanted Tech/Markdown
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature/25176 bitbucket readme kat-kan/mattermost-plugin-bitbucket
4 participants
@mattermod @kat-kan @amyblais @cwarnermm