Skip to content

Repeated information in Docs #878

@iam4tune

Description

@iam4tune

What is inaccurate?

We have content in our documentation that contains the same or similar information repeated in sometimes two or more locations. This duplicate content can cause a confusion on what instruction our users should follow, as one section may be up to date, and the other(s) may contain obsolete information.

We can fix this by identifying sections that have this duplicate information and then restructuring the content to include crosslinks. My suggestion would be to leave the actual steps in the tutorials and then reference them in articles we have in our documentation. Matt suggested a solution in #577 to address a similar scenario with Parabricks.

  • Identify duplicate information in our docs
  • Restructure identified duplicate content and include crosslinks where necessary.

Where is the inaccuracy?

  1. LTS - https://docs.rc.uab.edu/data_management/lts/interfaces/#installation-of-s3cmd-and-s5cmd-on-cheaha has the same information as https://docs.rc.uab.edu/data_management/lts/tutorial/individual_lts_tutorial/#install-s3cmd-within-conda-environment-on-cheaha
  2. Conda - Conda potentially has similar issues, but we already have a plan for this.
  3. Parabricks - Scenario mentioned in Case Study Organization #577.
  4. OSG - Scenario mention in Case Study Organization #577.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions