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

GH53958: Fix xref guidelines for contrib doc #65908

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GH53958: Fix xref guidelines for contrib doc #65908

wants to merge 1 commit into from

Conversation

bobfuru
Copy link
Contributor

@bobfuru bobfuru commented Oct 6, 2023 •
edited

As called out in the comments: #53958

This updates the /baz/zig and /baz/zag examples.

@openshift/team-documentation PTAL

@openshift-ci-robot
Copy link

@bobfuru: No Jira issue with key GH-53958 exists in the tracker at https://issues.redhat.com/.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

In response to this:

As called out in the comments: #53958

This updates the /baz/zig and /baz/zag examples.

@openshift/team-documentation PTAL

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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-ci openshift-ci bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 6, 2023
@openshift-ci-robot
Copy link

@bobfuru: No Jira issue with key GH-53958 exists in the tracker at https://issues.redhat.com/.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

In response to this:

As called out in the comments: #53958

This updates the /baz/zig and /baz/zag examples.

@openshift/team-documentation PTAL

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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-ci-robot
Copy link

@bobfuru: No Jira issue with key GH-53958 exists in the tracker at https://issues.redhat.com/.
Once a valid jira issue is referenced in the title of this pull request, request a refresh with /jira refresh.

In response to this:

As called out in the comments: #53958

This updates the /baz/zig and /baz/zag examples.

@openshift/team-documentation PTAL

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.

@bobfuru bobfuru changed the title GH-53958: Fix xref guidelines for contrib doc GH53958: Fix xref guidelines for contrib doc Oct 6, 2023
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Oct 6, 2023 •
edited

🤖 Fri Feb 02 16:59:37 - Prow CI generated the docs preview: https://65908--ocpdocs-pr.netlify.app

@bergerhoffer
Copy link
Contributor

@rolfedh can you please review for Hacktoberfest?

@rolfedh
Copy link
Contributor

rolfedh commented Oct 16, 2023

@rolfedh can you please review for Hacktoberfest?

@bergerhoffer It looks you're already engaged in reviewing this one. Please take it from here.

@openshift-ci openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 17, 2023
@bobfuru
Copy link
Contributor Author

bobfuru commented Oct 17, 2023

Hi @bergerhoffer PTAL, not sure if this is what you had in mind for combining to one scenario? Thanks!

bergerhoffer
bergerhoffer reviewed Oct 17, 2023
View reviewed changes
Copy link
Contributor

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

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

@bobfuru Boy you thought you were picking up an easy one for Hacktoberfest, didn't you? 😉

Anyways, this whole section needs redone. I didn't test it, but I took a stab at rearranging the whole section in this gist: https://gist.github.com/bergerhoffer/a6b8ff4ece7c90ca9105e2ed447142cb

If you want to take that as a starting point / feel free to adjust as you see fit. Thanks again! :)

contributing_to_docs/doc_guidelines.adoc Outdated Show resolved Hide resolved
contributing_to_docs/doc_guidelines.adoc Outdated Show resolved Hide resolved
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 17, 2023
@bobfuru
Copy link
Contributor Author

bobfuru commented Oct 17, 2023

Thanks for doing the work, @bergerhoffer. I plugged in your gist edits to overwrite cuz they look better than anything I could come up with. Déjà vu! 🤣

mburke5678
mburke5678 reviewed Oct 18, 2023
View reviewed changes
contributing_to_docs/doc_guidelines.adoc Outdated
....
openshift-docs/
openshift-docs/foo
openshift-docs/foo/bar.adoc
Copy link
Contributor

Choose a reason for hiding this comment

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

Per ISG do not use foo or foobar, as they are "variants of an acronym of a profanity."

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, use /fu/bob instead! (I'm kidding)

Good to see you @bobfuru! 👋

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point @mburke5678. We could change these to things like "test1" and "test2" and "example1", "example2", etc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I substituted foo_bar_baz_zig variables with test1_test2_test3_example1 variables. But if you have something else in mind, let me know.

@bobfuru
openshiftGH-53958: Fix xref guidelines for contrib doc
7b8ea39 
Fix xref guidelines for contrib doc, make 1 scenario

Fix xref guidelines for contrib doc, make 1 scenario

openshiftGH-53958: Fix xref guidelines for contrib doc

As called out in the comments: openshift#53958

This updates the `/baz/zig` and `/baz/zag` examples.

@openshift/team-documentation PTAL
@bergerhoffer
Copy link
Contributor

Sorry for the delay @bobfuru, our GA was today :) I marked this as hacktoberfest-accepted and will come back in the next day or so to finish reviewing!

@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 30, 2024
@ShaunaDiaz
Copy link
Contributor

@bergerhoffer Is this PR good to merge?

@ShaunaDiaz
Copy link
Contributor

/retest

@ShaunaDiaz
Copy link
Contributor

/remove-lifecycle stale

@openshift-ci openshift-ci bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 2, 2024
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Feb 2, 2024

@bobfuru: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bergerhoffer bergerhoffer bergerhoffer left review comments

@mburke5678 mburke5678 mburke5678 left review comments

@sheriff-rh sheriff-rh sheriff-rh left review comments

Assignees
No one assigned
Labels
Hacktoberfest hacktoberfest-accepted lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
9 participants
@bobfuru @openshift-ci-robot @ocpdocs-previewbot @bergerhoffer @rolfedh @openshift-bot @ShaunaDiaz @mburke5678 @sheriff-rh