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.

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

Links to Layers' Model Conceptual Overview Links Broken #968

Closed
ohsh6o opened this issue Jun 19, 2021 · 0 comments · Fixed by #973
Closed

Links to Layers' Model Conceptual Overview Links Broken #968

ohsh6o opened this issue Jun 19, 2021 · 0 comments · Fixed by #973
Labels
Milestone

Comments

@ohsh6o
Copy link
Contributor

ohsh6o commented Jun 19, 2021

Describe the bug

After separation between conceptual material and versioned reference material, the conceptual overview links in each layer model in Markdown have empty links (- **[Conceptual Overview]():** in each respective model). This makes documentation difficult to grasp for newer OSCAL adopters. This issue appears to be a repeat pattern in all layer docs across all versioned references.

Who is the bug affecting?

All who attempt to read about conceptual overview docs as linked back from the models.

What is affected by this bug?

Clarity of mapping between concrete layer model documentation to higher-level conceptual docs for OSCAL.

When does this occur?

All the time when a user reads docs.

How do we replicate the issue?

{What are the steps to reproduce the behavior?

  1. Read the layer model docs
  2. Attempt to click the conceptual overview link.
  3. Observe the links do not properly link to a target resource.
  4. Compare to doc arch from previous versions from before Request for Comment: Recommendations for Separation of High-Level and Technical Documentation #939.

Expected behavior (i.e. solution)

The conceptual overview link has a valid target to a proper HTML document.

@ohsh6o ohsh6o added the bug label Jun 19, 2021
ohsh6o pushed a commit to ohsh6o/OSCAL that referenced this issue Jun 19, 2021
@ohsh6o ohsh6o mentioned this issue Jun 19, 2021
8 tasks
david-waltermire added a commit that referenced this issue Jun 29, 2021
…973)

* Fixing broken and stale links in model documentation. Resolves #968.
@david-waltermire david-waltermire added this to the OSCAL 1.0.1 milestone Jan 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants