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

Fix CSS for choice elements in outline docs #1365

Closed
3 tasks done
aj-stein-nist opened this issue Jul 14, 2022 · 4 comments · Fixed by #1687
Closed
3 tasks done

Fix CSS for choice elements in outline docs #1365

aj-stein-nist opened this issue Jul 14, 2022 · 4 comments · Fixed by #1687
Assignees
Labels
enhancement Scope: Website Issues targeted at the OSCAL project website. User Story
Milestone

Comments

@aj-stein-nist
Copy link
Contributor

aj-stein-nist commented Jul 14, 2022

User Story

As an OSCAL tools developer, in order to better understand the use of choice in outline documentation, I want better layout so I can better understand hierarchical options of choices and their relationships to sibling elements that are siblings (even though they look like children).

Goals

We want to adjust the choice so, per the example below, condition and test-reference are on the same level of the hierarchy as pre-condition not indented as children of it.

oscal_reference_docs_choice_layout

Dependencies

No response

Acceptance Criteria

  • All OSCAL website and readme documentation affected by the changes in this issue have been updated. Changes to the OSCAL website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@aj-stein-nist
Copy link
Contributor Author

Assigning from Dave to myself as he rolled off the project. Will review backlog and consider priority and whether to include in next sprint or backlog.

@aj-stein-nist
Copy link
Contributor Author

Talked with @david-waltermire-nist Friday. Dave still likely has some WIP code for this issue on his workstation he can get over to us on Tuesday.

@aj-stein-nist aj-stein-nist removed their assignment Mar 1, 2023
@nikitawootten-nist nikitawootten-nist self-assigned this Mar 2, 2023
@nikitawootten-nist
Copy link
Contributor

I'm picking this up for the current sprint.

@nikitawootten-nist
Copy link
Contributor

Below are a few options I've come up with that maintain the same indentation while clearly showing which children belong to a choice. I'm personally leaning towards option 2.

Option 1:

Deindent the choices to the same position as the other entries using a negative margin, and set a background color to convey which children belong to the choice.

Screenshot 2023-03-02 at 12 03 15 PM

Option 2:

Same as option 1, but prevent the background from overflowing to the right.

Screenshot 2023-03-02 at 12 06 36 PM

Option 3:

Add a horizontal line at the same point of indentation, conveying that the elements are not children of the previous elements while maintaining the "cascading" design.

Screenshot 2023-03-02 at 11 59 58 AM

@aj-stein-nist aj-stein-nist linked a pull request Mar 2, 2023 that will close this issue
9 tasks
aj-stein-nist added a commit that referenced this issue Mar 3, 2023
* Fix CSS for choice elements in outline docs
Fixes #1365

* Update docs/assets/scss/schema-docs.scss

Co-authored-by: A.J. Stein <[email protected]>

---------

Co-authored-by: A.J. Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jun 29, 2023
* Fix CSS for choice elements in outline docs
Fixes usnistgov#1365

* Update docs/assets/scss/schema-docs.scss

Co-authored-by: A.J. Stein <[email protected]>

---------

Co-authored-by: A.J. Stein <[email protected]>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this issue Jul 10, 2023
* Fix CSS for choice elements in outline docs
Fixes usnistgov#1365

* Update docs/assets/scss/schema-docs.scss

Co-authored-by: A.J. Stein <[email protected]>

---------

Co-authored-by: A.J. Stein <[email protected]>
aj-stein-nist added a commit to galtm/OSCAL that referenced this issue Sep 28, 2023
* Fix CSS for choice elements in outline docs
Fixes usnistgov#1365

* Update docs/assets/scss/schema-docs.scss

Co-authored-by: A.J. Stein <[email protected]>

---------

Co-authored-by: A.J. Stein <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Scope: Website Issues targeted at the OSCAL project website. User Story
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants