openshift / openshift/openshift-docs
Remove xrefs from modules
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 883
- Forks
- 2k
- Avg merge
- 21h 5m
- Merged PRs (30d)
- 737
Description
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).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the modules/ directory for xrefs and review each occurrence against the module guidelines. Remove the xrefs while commenting them out or leaving notes so they can be restored later if allowed. Done means the module sweep is complete and no active xrefs remain there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100