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

Add snippets symlink in modules dir #41466

Merged
merged 1 commit into from
Feb 4, 2022

Conversation

adellape
Copy link
Contributor

@adellape adellape commented Feb 4, 2022

Text snippets are allowed in modules, but they need a symlink from the modules/ directory to the snippets/ directory if they're going to be included with a relative reference in the following form:

include::snippets/technology-preview.adoc[]

Also update the Tech Preview example in the guidelines since the old PR-link example was using the former modules/ directory and showing a leveloffset that I don't think we need.

^ Actually gonna do this in a separate PR (#41477) because of branch drift for the guidelines file.

@netlify
Copy link

netlify bot commented Feb 4, 2022

✔️ Deploy Preview for osdocs ready!

🔨 Explore the source changes: 9ac05fd

🔍 Inspect the deploy log: https://app.netlify.com/sites/osdocs/deploys/61fdb106216e340008ea20c3

😎 Browse the preview: https://deploy-preview-41466--osdocs.netlify.app

@adellape adellape force-pushed the snippets-symlink-guideline branch from ce4c75b to e255ce8 Compare February 4, 2022 21:02
[source,text]
----
:FeatureName: The XYZ plug-in
\include::snippets/technology-preview.adoc[]
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you need the \ here?
Will you fix the typo on line 110?
Otherwise, this LGTM!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yea, it escapes the include directive, otherwise it renders like:

image

Will fix the line 110 ordered numbering too. 👍

@adellape adellape force-pushed the snippets-symlink-guideline branch from e255ce8 to 01759d7 Compare February 4, 2022 22:32
@adellape adellape changed the title Add snippets symlink in modules/ and update TP guideline Add snippets symlink in modules dir Feb 4, 2022
@adellape adellape force-pushed the snippets-symlink-guideline branch from 01759d7 to 633055c Compare February 4, 2022 23:02
@adellape adellape force-pushed the snippets-symlink-guideline branch from 633055c to 9ac05fd Compare February 4, 2022 23:04
@openshift-ci openshift-ci bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 4, 2022
@adellape
Copy link
Contributor Author

adellape commented Feb 4, 2022

Updated this PR to just be about the symlink, and split the repo guideline TP edits to #41477.

@adellape adellape merged commit d7815a7 into openshift:main Feb 4, 2022
@adellape adellape deleted the snippets-symlink-guideline branch February 4, 2022 23:09
@adellape
Copy link
Contributor Author

adellape commented Feb 4, 2022

/cherrypick enterprise-4.10

@adellape
Copy link
Contributor Author

adellape commented Feb 4, 2022

/cherrypick enterprise-4.9

@adellape
Copy link
Contributor Author

adellape commented Feb 4, 2022

/cherrypick enterprise-4.8

@adellape
Copy link
Contributor Author

adellape commented Feb 4, 2022

/cherrypick enterprise-4.7

@adellape
Copy link
Contributor Author

adellape commented Feb 4, 2022

/cherrypick enterprise-4.6

@openshift-cherrypick-robot

@adellape: new pull request could not be created: failed to create pull request against openshift/openshift-docs#enterprise-4.10 from head openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.10: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.10 and openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.10"}],"documentation_url":"https://docs.github.com/rest/reference/pulls#create-a-pull-request"}

In response to this:

/cherrypick enterprise-4.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@adellape: new pull request could not be created: failed to create pull request against openshift/openshift-docs#enterprise-4.9 from head openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.9: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.9 and openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.9"}],"documentation_url":"https://docs.github.com/rest/reference/pulls#create-a-pull-request"}

In response to this:

/cherrypick enterprise-4.9

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@adellape: new pull request could not be created: failed to create pull request against openshift/openshift-docs#enterprise-4.8 from head openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.8: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.8 and openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.8"}],"documentation_url":"https://docs.github.com/rest/reference/pulls#create-a-pull-request"}

In response to this:

/cherrypick enterprise-4.8

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@adellape: new pull request could not be created: failed to create pull request against openshift/openshift-docs#enterprise-4.7 from head openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.7: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.7 and openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.7"}],"documentation_url":"https://docs.github.com/rest/reference/pulls#create-a-pull-request"}

In response to this:

/cherrypick enterprise-4.7

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@adellape: new pull request could not be created: failed to create pull request against openshift/openshift-docs#enterprise-4.6 from head openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.6: status code 422 not one of [201], body: {"message":"Validation Failed","errors":[{"resource":"PullRequest","code":"custom","message":"No commits between openshift:enterprise-4.6 and openshift-cherrypick-robot:cherry-pick-41466-to-enterprise-4.6"}],"documentation_url":"https://docs.github.com/rest/reference/pulls#create-a-pull-request"}

In response to this:

/cherrypick enterprise-4.6

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@adellape
Copy link
Contributor Author

adellape commented Feb 4, 2022

The cherry-picks failed seemingly because the symlinks are already in those branches. So I suppose what maybe happened was the symlink wasn't created in the main branch version of #39854, but it was in the cherry-pick PRs to the versioned branches. 🤷 My testing earlier was in a branch based off of main, so I didn't catch the difference then.

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

Successfully merging this pull request may close these issues.

3 participants