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

Formatting fixes (OVN-IC, PR template) #200

Merged
merged 2 commits into from
Sep 9, 2024

Conversation

qmonnet
Copy link
Contributor

@qmonnet qmonnet commented Sep 9, 2024

  • with-ovn-ic: Fix formatting for prerequisites list

  • .github: Fix Pull Request template links

  • Make sure you have followed the Document Convention.

Formatting for the enumerated list for OVN-IC interconnection
prerequisites is broken and does not render properly, because some
indentation is missing (in the English version) and a blank line must be
added (both versions). Add the missing indent and blank lines.

Signed-off-by: Quentin Monnet <[email protected]>
The link to the conventions document is correct when reading it from the
template files, but does not render properly in the browser, because we
need to tell GitHub we're looking at a blob from the master branch.

The main purpose for this template is to be rendered in the browser, so
this is where the link should work correctly. Fix the URL to point to
the right document, and add a second link to the English version of the
document.

Signed-off-by: Quentin Monnet <[email protected]>
@oilbeater oilbeater merged commit d0b4e24 into kubeovn:master Sep 9, 2024
2 checks passed
@oilbeater
Copy link
Contributor

Thanks! @qmonnet

@qmonnet qmonnet deleted the pr/doc-fixes branch September 9, 2024 14:30
oilbeater pushed a commit that referenced this pull request Sep 10, 2024
* with-ovn-ic: Fix formatting for prerequisites list

Formatting for the enumerated list for OVN-IC interconnection
prerequisites is broken and does not render properly, because some
indentation is missing (in the English version) and a blank line must be
added (both versions). Add the missing indent and blank lines.

Signed-off-by: Quentin Monnet <[email protected]>

* .github: Fix Pull Request template links

The link to the conventions document is correct when reading it from the
template files, but does not render properly in the browser, because we
need to tell GitHub we're looking at a blob from the master branch.

The main purpose for this template is to be rendered in the browser, so
this is where the link should work correctly. Fix the URL to point to
the right document, and add a second link to the English version of the
document.

Signed-off-by: Quentin Monnet <[email protected]>

---------

Signed-off-by: Quentin Monnet <[email protected]>
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.

2 participants