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

docs: add rfc section #15354

Merged
merged 2 commits into from
Mar 10, 2023
Merged

docs: add rfc section #15354

merged 2 commits into from
Mar 10, 2023

Conversation

tac0turtle
Copy link
Member

Description

This pr adds an RFC section for items that may not need adrs right away or to capture ongoing conversations


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@tac0turtle tac0turtle marked this pull request as ready for review March 10, 2023 17:33
@tac0turtle tac0turtle requested a review from a team as a code owner March 10, 2023 17:33
@@ -0,0 +1,35 @@
# RFC {RFC-NUMBER}: {TITLE}
Copy link
Member

Choose a reason for hiding this comment

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

---
sidebar_position: 1
---

?

Copy link
Member Author

Choose a reason for hiding this comment

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

we dont have this on the adr section, ideally we tell it to not show the template files like we do today

Copy link
Member

Choose a reason for hiding this comment

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

Yeah it is fine without it too. It was only required for the README to show properly I think.

@tac0turtle tac0turtle merged commit 16a5404 into main Mar 10, 2023
@tac0turtle tac0turtle deleted the marko/add_rfc_section branch March 10, 2023 17:46
@julienrbrt
Copy link
Member

Just seen that it does not actually shows in the docs.
This is because it is in docs/rfc, which is clearer when browsing the GH repo, but at the docs building we need to copy that in docs/docs.

@julienrbrt julienrbrt mentioned this pull request Mar 10, 2023
19 tasks
@@ -0,0 +1,38 @@
---
sidebar_position: 0
Copy link
Member

@julienrbrt julienrbrt Mar 10, 2023

Choose a reason for hiding this comment

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

My bad @tac0turtle , it was sidebar_position: 1 needed here.
image
As it is a main section, setting 0 makes it as important as the doc homepage readme :/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants