Feature/25176 bitbucket readme #125

kat-kan · 2023-10-26T21:50:17Z

Summary

This PR organizes README.md, admin-guide.md and project assets in a way described here mattermost/mattermost#25176
I have

reorganized files (admin guide split to separate file, assets moved to docs/images)
updated files that use images (new directory)
added outline to both .md files
added missing headlines
formatted files
added badges to README (however, I don't have access to any code coverage report so it's empty for now)

Ticket Link

Fixes mattermost/mattermost#25176
https://mattermost.atlassian.net/browse/MM-55077

… new directory

* Add badges * Add new outline * Move admin guide to new file in docs directory

* Add outline * Add missing headers

mattermost-build · 2023-10-26T21:50:22Z

Hello @kat-kan,

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.

Per the Mattermost Contribution Guide, we need to add you to the list of approved contributors for the Mattermost project.

Please help complete the Mattermost contribution license agreement?
Once you have signed the CLA, please comment with /check-cla and confirm that the CLA check is green.

This is a standard procedure for many open source projects.

Please let us know if you have any questions.

We are very happy to have you join our growing community! If you're not yet a member, please consider joining our Contributors community channel to meet other contributors and discuss new opportunities with the core team.

kat-kan · 2023-10-26T21:52:57Z

/check-cla

kat-kan · 2023-10-26T21:55:05Z

cwarnermm · 2023-10-27T13:01:31Z

@mickmister - Looking forward to your technical review of this PR -- particularly the image updates.

kat-kan · 2023-10-29T14:48:37Z

I am also looking forward to the review :)

hanzei

The overall direction looks good 👍

There are still a couple of times that need work before we can merge the PR.

docs/images/profile.png

README.md

docs/admin-guide.md

cwarnermm · 2023-10-30T12:48:57Z

@kat-kan - You've done a very good job with this PR. Thank you for being so flexible and understanding about the feedback you received during @hanzei's technical review.

@hanzei - Thank you for a most excellent review! :)

mickmister

Thanks for the contribution @kat-kan 🎉

LGTM, given hanzei's requests are fulfilled. Thanks!

cwarnermm · 2023-10-31T12:50:09Z

@hanzei - I believe the only check remaining is to ensure that the image assets are in the correct location.

kat-kan · 2023-10-31T13:10:42Z

@cwarnermm I believe they are but builds are failing after moving images because they expect specific location. I am waiting for confirmation that I should revert changes.

…les with new directory" This reverts commit 9d24874.

kat-kan · 2023-10-31T15:23:18Z

I reverted the changes related to images, every suggestion was introduced

hanzei

We are getting there 🎉

README.md

kat-kan · 2023-11-05T07:51:12Z

@cwarnermm as we are still waiting for @hanzei to accept the changes, can you please consider adding "hacktoberfest-accepted" label? The review period in Hacktoberfest ends tomorrow and PR has to be either merged or have the label to be even considered.

hanzei

Awesome, thank you @kat-kan 💯

codecov-commenter · 2023-11-06T10:56:50Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (84a4030) 15.03% compared to head (29bf6d4) 15.03%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #125   +/-   ##
=======================================
  Coverage   15.03%   15.03%           
=======================================
  Files          13       13           
  Lines        2301     2301           
=======================================
  Hits          346      346           
  Misses       1936     1936           
  Partials       19       19

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

hanzei · 2023-11-06T11:07:58Z

@mickmister The broken CI is unrelated to the PR. What are the next steps to getting it fixed?

mickmister · 2023-11-07T06:03:01Z

@hanzei I created #127 to fix the issue

mickmister · 2023-11-09T04:41:00Z

/update-branch

mickmister · 2023-11-09T04:48:27Z

@mickmister - Looking forward to your technical review of this PR -- particularly the image updates.

@cwarnermm I'm not sure there are any image updates in the PR?

mattermost-build · 2023-11-20T01:02:37Z

This PR has been automatically labelled "stale" because it hasn't had recent activity.
A core team member will check in on the status of the PR to help with questions.
Thank you for your contribution!

mickmister

Thanks @kat-kan! I have just one suggestion to check-in an image that is currently pointing to https://user-images.githubusercontent.com. This was already pointing to that so the change is optional for this PR, though since we are cleaning up the README I think why not.

Your work LGTM 👍 Thanks so much!

mickmister · 2023-11-20T02:46:36Z

README.md


-### Onboard users
+![Bitbucket plugin screenshot](https://user-images.githubusercontent.com/45372453/97643091-114a1500-1a47-11eb-9863-2e0e308706ea.png)


Can we instead have the image committed to this repo?

kat-kan added 3 commits October 26, 2023 23:29

Move assets to new directory (docs/images). Update project files with…

9d24874

… new directory

Update README.md

d478ad4

* Add badges * Add new outline * Move admin guide to new file in docs directory

Organize admin-guide.md

f71ced3

* Add outline * Add missing headers

mattermost-build added the Hacktoberfest label Oct 26, 2023

kat-kan mentioned this pull request Oct 26, 2023

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

Open

cwarnermm self-requested a review October 27, 2023 12:50

cwarnermm added the Editor Review label Oct 27, 2023

cwarnermm requested review from mickmister and hanzei October 27, 2023 12:58

hanzei requested changes Oct 30, 2023

View reviewed changes

docs/images/profile.png Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

docs/admin-guide.md Outdated Show resolved Hide resolved

hanzei added the 2: Dev Review Requires review by a core committer label Oct 30, 2023

mickmister approved these changes Oct 30, 2023

View reviewed changes

kat-kan added 2 commits October 30, 2023 17:35

Remove Marketplace from admin-guide as requested in CR

e3e30cd

Remove empty headlines from README and admin-guide

f51bbd9

cwarnermm requested review from hanzei and mickmister October 31, 2023 12:48

cwarnermm approved these changes Oct 31, 2023

View reviewed changes

kat-kan added 2 commits October 31, 2023 16:13

Revert "Move assets to new directory (docs/images). Update project fi…

6f73c7d

…les with new directory" This reverts commit 9d24874.

Remove code coverage badge as agreed in CR

764c498

hanzei requested changes Nov 1, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Adjust Admin Guide section as requested in CR

b0518f7

Adjust Help Wanted as requested in CR

29bf6d4

kat-kan requested a review from hanzei November 3, 2023 12:44

hanzei added the hacktoberfest-accepted label Nov 6, 2023

hanzei approved these changes Nov 6, 2023

View reviewed changes

Merge branch 'master' into feature/25176-bitbucket-readme

644bc1f

mattermost-build added the Lifecycle/1:stale label Nov 20, 2023

mickmister approved these changes Nov 20, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/25176 bitbucket readme #125

Feature/25176 bitbucket readme #125

kat-kan commented Oct 26, 2023

mattermost-build commented Oct 26, 2023

kat-kan commented Oct 26, 2023

kat-kan commented Oct 26, 2023

cwarnermm commented Oct 27, 2023

kat-kan commented Oct 29, 2023

hanzei left a comment

cwarnermm commented Oct 30, 2023

mickmister left a comment

cwarnermm commented Oct 31, 2023

kat-kan commented Oct 31, 2023

kat-kan commented Oct 31, 2023 •

edited

Loading

hanzei left a comment

kat-kan commented Nov 5, 2023

hanzei left a comment

codecov-commenter commented Nov 6, 2023

hanzei commented Nov 6, 2023

mickmister commented Nov 7, 2023

mickmister commented Nov 9, 2023

mickmister commented Nov 9, 2023

mattermost-build commented Nov 20, 2023

mickmister left a comment

mickmister Nov 20, 2023


		### Onboard users
		![Bitbucket plugin screenshot](https://user-images.githubusercontent.com/45372453/97643091-114a1500-1a47-11eb-9863-2e0e308706ea.png)

Feature/25176 bitbucket readme #125

Are you sure you want to change the base?

Feature/25176 bitbucket readme #125

Conversation

kat-kan commented Oct 26, 2023

Summary

Ticket Link

mattermost-build commented Oct 26, 2023

kat-kan commented Oct 26, 2023

kat-kan commented Oct 26, 2023

cwarnermm commented Oct 27, 2023

kat-kan commented Oct 29, 2023

hanzei left a comment

Choose a reason for hiding this comment

cwarnermm commented Oct 30, 2023

mickmister left a comment

Choose a reason for hiding this comment

cwarnermm commented Oct 31, 2023

kat-kan commented Oct 31, 2023

kat-kan commented Oct 31, 2023 • edited Loading

hanzei left a comment

Choose a reason for hiding this comment

kat-kan commented Nov 5, 2023

hanzei left a comment

Choose a reason for hiding this comment

codecov-commenter commented Nov 6, 2023

Codecov Report

hanzei commented Nov 6, 2023

mickmister commented Nov 7, 2023

mickmister commented Nov 9, 2023

mickmister commented Nov 9, 2023

mattermost-build commented Nov 20, 2023

mickmister left a comment

Choose a reason for hiding this comment

mickmister Nov 20, 2023

Choose a reason for hiding this comment

kat-kan commented Oct 31, 2023 •

edited

Loading