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 #1687

Merged
merged 2 commits into from
Mar 3, 2023
Merged

Fix CSS for choice elements in outline docs #1687

merged 2 commits into from
Mar 3, 2023

Conversation

nikitawootten-nist
Copy link
Contributor

@nikitawootten-nist nikitawootten-nist commented Mar 2, 2023

Committer Notes

Fixes #1365

Choices are now displayed in outlines as follows:

JSON view:
Screenshot 2023-03-02 at 2 05 14 PM

XML view:
Screenshot 2023-03-02 at 2 06 10 PM

Nested choices alternate between white (the background color) and light gray up to a depth of 3 (I assume if things get deeper then 3 levels of choices, we have other problems)

This change has been tested on both Firefox and Chrome.

UPDATE 3/3/23

@aj-stein-nist suggested changing the color to fit our palette, as well as re-adding a bit of indentation:

image

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all OSCAL website and readme documentation affected by the changes you made? Changes to the OSCAL website can be made in the docs/content directory of your branch.

@nikitawootten-nist
Copy link
Contributor Author

Relevant lines live on lines 154-173

@aj-stein-nist aj-stein-nist linked an issue Mar 2, 2023 that may be closed by this pull request
3 tasks
@aj-stein-nist
Copy link
Contributor

I will take this for a spin later tonight or tomorrow, personally I am preferential to Option 3. Would like to know what the rest of the team thinks.

wendellpiez
wendellpiez previously approved these changes Mar 3, 2023
Copy link
Contributor

@wendellpiez wendellpiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving so as not to block improvement - while a more thorough redesign/shakeout of CSS may also be in order (some day) ...

@nikitawootten-nist
Copy link
Contributor Author

I will take this for a spin later tonight or tomorrow, personally I am preferential to Option 3. Would like to know what the rest of the team thinks.

For those reviewing this, Option 3 refers to the mock ups I posted here.

Personally Option 3 looks a little confusing to me, but if the team would rather a more muted line instead of coloring the whole background, I can probably improve the design as well.

@aj-stein-nist
Copy link
Contributor

I will take this for a spin later tonight or tomorrow, personally I am preferential to Option 3. Would like to know what the rest of the team thinks.

For those reviewing this, Option 3 refers to the mock ups I posted here.

Personally Option 3 looks a little confusing to me, but if the team would rather a more muted line instead of coloring the whole background, I can probably improve the design as well.

I was going to say: you like the boxes!? But if you want more muted lines I could understand. That said: I think the most key thing is a very clear visual identifier that shows the indentation or "hierarchy" of the objects in the model, and the box options make that less obvious to me personally. But it seems we are in the same head space.

So we like the line concept, but could make it better, is that the takeaway?

@wendellpiez
Copy link
Contributor

I actually like the lines, but I also wonder if the indents shouldn't be at the level down, i.e. the choices. A left-side rule might be made to span across them. So the p would in effect look like a list header. (Unfortunately we don't have yet another wrapper around the group of choice divs.)

However I am also not inclined to quibble here, as they are all improvements to legibility.

Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am of mixed my minds of whether to point this change to develop or main given it's a site change, but I guess we should stick with develop for now.

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
Copy link
Contributor

@aj-stein-nist aj-stein-nist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 it.

@aj-stein-nist aj-stein-nist merged commit e3c4432 into usnistgov:develop Mar 3, 2023
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this pull request 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 <alexander.stein@nist.gov>

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
aj-stein-nist added a commit to aj-stein-nist/OSCAL-forked that referenced this pull request 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 <alexander.stein@nist.gov>

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
@aj-stein-nist aj-stein-nist added this to the v1.1.0 milestone Jul 27, 2023
aj-stein-nist added a commit to galtm/OSCAL that referenced this pull request 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 <alexander.stein@nist.gov>

---------

Co-authored-by: A.J. Stein <alexander.stein@nist.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix CSS for choice elements in outline docs
3 participants