Skip to content

Conversation

@xamberl
Copy link
Contributor

@xamberl xamberl commented Nov 27, 2024

Major changes

  • Added Basic Shell Commands
  • Added custom CSS, particularly adding a new block quote style that can be enabled by appending {:.tip-header} and {:.tip} to block quotes. See an example here.

Less major (but still not minor) changes

@xamberl xamberl changed the title Preview xalim login Revised login guides, new "basic shell commands" guide, custom CSS Nov 27, 2024
@xamberl
Copy link
Contributor Author

xamberl commented Nov 27, 2024

@CannonLock Can you specifically review the CSS? I hacked this together, but I want to ensure that this is okay to do, or if there's another way to implement this kind of formatting.

Copy link
Contributor

@ChristinaLK ChristinaLK left a comment

Choose a reason for hiding this comment

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

I think this looks great! Things I'll want to discuss at some point:

  • items that fall under "style guide" - agreeing on how we capitalize headers, and confirming that we want to remove outline numbers/letters in our headers(I'm in favor esp now that we have clickable headers, just want to document).
  • sort of related -- going through a few guides together and how we would restructure them to match the format you've created here.
  • I see the summary possibly getting out of date because we forget to update it as we update the page. 😅
  • What are your thoughts on adding some more formatting to our header styles to better distinguish levels 1 - 4? We did this on the OSG docs (a little) and it looks like this: https://portal.osg-htc.org/documentation/htc_workloads/using_software/containers-singularity/

I LOVE the way it looks to have the 2FA video in its own "tip" box. If we make a bunch more videos, that's a good model for integrating them. Ditto having the table of ssh tools - am realizing we could use those a LOT MORE in our docs and that's a great use case.

I added the suggestions about Option 1 vs Option 2 -- not sure if that's strictly necessary, but I like to clarify when two headers are sequential / additive vs disjoint, if that makes sense? But I also don't need to die on that hill, partially because I don't like the way it looks - I prefer the simplicity of just the header name. :)

Copy link
Contributor

@aowen-uwmad aowen-uwmad left a comment

Choose a reason for hiding this comment

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

Good to go after addressing comments.

Copy link
Member

@CannonLock CannonLock left a comment

Choose a reason for hiding this comment

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

LGTM.

@xamberl xamberl merged commit 8489226 into master Jan 8, 2025
2 of 3 checks passed
@xamberl xamberl deleted the preview-xalim-login branch January 8, 2025 22:12
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.

5 participants