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

Update xref guidelines #53958

Open
maxwelldb opened this issue Dec 16, 2022 · 14 comments
Open

Update xref guidelines #53958

maxwelldb opened this issue Dec 16, 2022 · 14 comments
Assignees
@bobfuru
Labels
Hacktoberfest lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@maxwelldb
Copy link
Contributor

While working on https://issues.redhat.com/browse/OCPBUGS-4982, I realized that the xref guidelines in this repo are incorrect.

Ex: assemblies in the same directory are not linked to as demonstrated.

The xref guidelines should be fixed and verified.
@maxwelldb maxwelldb self-assigned this Dec 16, 2022
@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 Mar 17, 2023
@maxwelldb
Copy link
Contributor Author

/remove-lifecycle rotten

@openshift-bot
Copy link

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

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

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 18, 2023
@abrennan89 abrennan89 added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Apr 18, 2023
@rolfedh
Copy link
Contributor

rolfedh commented Sep 13, 2023

Thanks for reporting this issue, @maxwelldb. Could you provide a reference to the "xref guidelines in this repo"? I'm evaluating issues for hacktoberfest and this information would help.

@maxwelldb
Copy link
Contributor Author

image
Pulling from my Slack history, as it's been a while:

The example here should actually start xref:../baz/zag...

@rolfedh

@rolfedh
Copy link
Contributor

rolfedh commented Sep 14, 2023 •
edited
Loading

Thanks, Max! You didn't have to do that!
I need help finding the document you made a screenshot of. Can you give me a link?

@maxwelldb
Copy link
Contributor Author

maxwelldb commented Sep 14, 2023 •
edited
Loading

Oh! Yep. :)

Screenshot of error is from: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#links-to-internal-content

@maxwelldb maxwelldb removed their assignment Sep 14, 2023
@ShaunaDiaz ShaunaDiaz mentioned this issue Oct 4, 2023
Closed
bobfuru added a commit to bobfuru/openshift-docs that referenced this issue Oct 6, 2023
@bobfuru
openshiftGH-53958: Fix xref guidelines for contrib doc
891381e 
As called out in the comments: openshift#53958

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

@openshift/team-documentation PTAL
@bobfuru bobfuru mentioned this issue Oct 6, 2023
Closed
@bergerhoffer
Copy link
Contributor

@bobfuru 👋 can you comment on this issue so that we can assign it to you?

@bergerhoffer
Copy link
Contributor

@maxwelldb should these sections actually be combined? Afaik there isn't any difference in how an xref is contructed depending on whether the assembly is in the same directory or not.

If that's true, then it seems like we should get rid of "two scenarios" deal and just cut it down to here's how you xref.

@maxwelldb
Copy link
Contributor Author

Sounds copacetic.

@bobfuru
Copy link
Contributor

bobfuru commented Oct 13, 2023

Hi @bergerhoffer! 👋
Please assign this to me. Many thanks!

@bergerhoffer
Copy link
Contributor

@bobfuru Let me know if you'd be up for adjusting the xref guidelines like I recommended above. There really is no difference in the xref guidance depending on where you are linking to.

@rolfedh
Copy link
Contributor

rolfedh commented Oct 16, 2023

Hi @bergerhoffer. I was out on Friday. It looks like you've got this one.

bobfuru added a commit to bobfuru/openshift-docs that referenced this issue Oct 17, 2023
@bobfuru
Fix xref guidelines for contrib doc, make 1 scenario
8c5f3dc 
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
@bobfuru
Copy link
Contributor

bobfuru commented Oct 17, 2023

@bobfuru Let me know if you'd be up for adjusting the xref guidelines like I recommended above. There really is no difference in the xref guidance depending on where you are linking to.

Sure, added a change to the PR. Let me know what you think.

bobfuru added a commit to bobfuru/openshift-docs that referenced this issue Oct 17, 2023
@bobfuru
Fix xref guidelines for contrib doc, make 1 scenario
da69e8c 
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
bobfuru added a commit to bobfuru/openshift-docs that referenced this issue Oct 18, 2023
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bobfuru bobfuru

Labels
Hacktoberfest lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@rolfedh @openshift-bot @bergerhoffer @abrennan89 @bobfuru @maxwelldb