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

docs: add the contributing guides to docs #279

Merged
merged 1 commit into from
Dec 19, 2022
Merged

docs: add the contributing guides to docs #279

merged 1 commit into from
Dec 19, 2022

Conversation

jhmarina
Copy link
Contributor

Signed-off-by: Jesus Herman-Marina jherman@suse.com

Describe your changes

This PR implements a mkdocs plugin that renders a page taking content from another page. In this case it's injecting the content from CONTRIBUTING.md into docs/contributing.md

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.
  • CHANGELOG.md has been updated should there be relevant changes in this PR.

@jhmarina jhmarina self-assigned this Dec 15, 2022
@jhmarina jhmarina added the kind/documentation Improvements or additions to documentation label Dec 15, 2022
@jhmarina jhmarina added this to the v0.10.0 milestone Dec 15, 2022
@jhmarina jhmarina requested a review from giubacc December 15, 2022 14:45
m-ildefons
m-ildefons suggested changes Dec 16, 2022
View reviewed changes
Copy link
Contributor

@m-ildefons m-ildefons left a comment

Choose a reason for hiding this comment

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

Two small nits, but otherwise it looks good to me. Nicely done.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
giubacc
giubacc reviewed Dec 16, 2022
View reviewed changes
Copy link

@giubacc giubacc left a comment

Choose a reason for hiding this comment

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

with Moritz notes, LGTM

jecluis
jecluis reviewed Dec 16, 2022
View reviewed changes
Copy link
Contributor

@jecluis jecluis left a comment

Choose a reason for hiding this comment

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

lgtm once @m-ildefons 's comments have been addressed.

docs: add the contributing guides to docs
58b5b9f 
Signed-off-by: Jesus Herman-Marina <jherman@suse.com>
m-ildefons
m-ildefons approved these changes Dec 19, 2022
View reviewed changes
Copy link
Contributor

@m-ildefons m-ildefons left a comment

Choose a reason for hiding this comment

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

LGTM

@jhmarina jhmarina merged commit 3451246 into s3gw-tech:main Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@giubacc giubacc giubacc left review comments

@jecluis jecluis jecluis left review comments

@m-ildefons m-ildefons m-ildefons approved these changes

Assignees

@jhmarina jhmarina

Labels
kind/documentation Improvements or additions to documentation
Projects
None yet
Milestone
v0.10.0
Development

Successfully merging this pull request may close these issues.
4 participants
@jhmarina @jecluis @m-ildefons @giubacc