openshift / openshift-docs

OpenShift 3 and 4 product and community documentation
https://docs.openshift.com
Apache License 2.0
739 stars 1.7k forks source link

Remove xrefs from modules #41954

Open bergerhoffer opened 2 years ago

bergerhoffer commented 2 years ago

In reviewing a module, I noticed that there was an xref in it. A quick search of the modules/ directory showed quite a few in there.

We currently don't allow xrefs in modules per our guidelines. We should do a sweep and remove these xrefs. (Comment out or otherwise leave a note so that they can be found/added back in later, if/when we do allow them again).

openshift-bot commented 2 years ago

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

bergerhoffer commented 2 years ago

/remove-lifecycle stale

openshift-bot commented 1 year ago

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

bergerhoffer commented 1 year ago

/remove-lifecycle stale

openshift-bot commented 1 year ago

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

bergerhoffer commented 1 year ago

/remove-lifecycle stale

openshift-bot commented 1 year ago

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

bergerhoffer commented 1 year ago

/lifecycle frozen

bergerhoffer commented 1 year ago

/remove-lifecycle stale

peterroth commented 4 months ago

Is this still a valid ticket, @bergerhoffer? If so, could you please enlighten me if only the xrefs needs to be removed or they should be handled an other way?

bergerhoffer commented 4 months ago

@peterroth yes it is still valid, but unfortunately is not a quick/easy fix. They don't need to just be removed, they will each need to be evaluated and see if we need to add them in as a workaround elsewhere. I think we likely have a few hundred :/

peterroth commented 4 months ago

I see, @bergerhoffer. In this case I can't fix the ticket because I don't have the reliable resource to build and test the changes.

bergerhoffer commented 4 months ago

I see, @bergerhoffer. In this case I can't fix the ticket because I don't have the reliable resource to build and test the changes.

Agreed. This one will likely need to be done by our team, and likely broken up for several writers to do.

There are likely other tickets that are more suited for anyone to pick up, if you're looking to contribute more. Let me know if you need any help finding something, if you are!