Skip to content

Conversation

@vikram-redhat
Copy link
Contributor

@vikram-redhat vikram-redhat commented Mar 21, 2021

This PR:

  • Adds a single blank line before toc::[] in all assemblies.
  • Updates guidelines to make sure the assembly metadata specifies that a blank line be added after initial document header information and a toc.
  • Fixes the common-attributes.adoc to remove unnecessary attributes.

A separate PR will need to be created for each release branch.

@openshift-ci-robot openshift-ci-robot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 21, 2021
@netlify
Copy link

netlify bot commented Mar 21, 2021

Deploy preview for osdocs ready!

Built with commit 25b3e50

https://deploy-preview-30712--osdocs.netlify.app

@vikram-redhat vikram-redhat added this to the Next Release milestone Mar 21, 2021
@vikram-redhat vikram-redhat added the okd-only Content that is only relevant to upstream OKD docs. label Mar 21, 2021
Copy link
Contributor

@pneedle-rh pneedle-rh Mar 22, 2021

Choose a reason for hiding this comment

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

Some of the assemblies now have two preceding blank lines. Is it worth only adding blank lines to the assemblies that do not currently have one between the header and the toc declaration, for consistency?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, I've noticed this for the couple of serverless ones I've looked at so far also

Copy link
Contributor

Choose a reason for hiding this comment

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

I am trying to script a solution for this.

Copy link
Contributor

@pneedle-rh pneedle-rh Mar 22, 2021

Choose a reason for hiding this comment

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

I have now run a script against a local clone of this PR and then pushed the changes to the original commit. There should now be one blank line preceding the toc::[] line in each assembly file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @pneedle-rh

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

ACK from service mesh team. Just let us know when it merges so we make sure we rebase our PRs (we don't want to overwrite this accidentally!).

@ahardin-rh
Copy link
Contributor

LGTM!

include::modules/authentication-api-impersonation.adoc[leveloffset=+1]

include::modules/impersonation-project-creation.adoc[leveloffset=+1]
include::modules/impersonation-project-creation.adoc[leveloffset=+1]
Copy link
Contributor

@pneedle-rh pneedle-rh Mar 22, 2021

Choose a reason for hiding this comment

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

Where you see the last line in a file being removed and added in this PR, this is the TOC blank line correction script adding new lines to the end of a file where one did not previously exist. It was a side effect of the script, but it is useful.

@tradej
Copy link

tradej commented Mar 23, 2021

LGTM.

@Preeticp
Copy link
Contributor

Verified for odo, ODC, Helm, Build, Pipelines, GitOps, Logging. LGTM. Thank you @pneedle-rh and @vikram-redhat

@vikram-redhat
Copy link
Contributor Author

@pneedle-rh I am going to merge this. Please merge the rest of the release branch PRs.

@vikram-redhat vikram-redhat merged commit 9e99b44 into openshift:master Mar 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

okd-only Content that is only relevant to upstream OKD docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants