openshift / openshift/openshift-docs

Update xref guidelines

Open
#53,958 14 comments 0 reactions 1 assignee View on GitHub

@bobfuru is already working on this.

Since Oct 16, 2023.

Hacktoberfest lifecycle/frozen
Dominant language
HTML
Stars
883
Forks
2k
Avg merge
21h 5m
Merged PRs (30d)
737

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.