Add `Getting Started` page #374

b-reyes · 2024-10-16T22:11:37Z

This PR addresses #325 by creating a flowchart for both HPC and Cloud resources documentation. In addition to this major change, there was a large amount of reorganization and cleaning up of documentation. A summary of all changes is provided below.

Refactor and Reorganize Documentation

File Naming and Structure
- Rename and move directories and files for clarity (e.g., access to getting_started, Petalibrary to storage/petalibrary and name it mounting_images).
Tab Format Updates
- Update tabs in various markdown files to a new format for consistency across logging-in.md, OpenMP-C.md, OpenMP-Fortran.md, MPI-C.md, MPI-Fortran.md, MPIBestpractices.md, coding-best-practices.md, spack.md, petalibrary.md, batch-jobs.md,interactive-jobs.md, alpine-hardware, slurm_directive_ex, and filesystems pages.
- Remove all old css and libraries associated with old tabs. Ensure that spinx-design is a requirement now.
Document Clean-up
- Remove unused directories: XSEDE, Templates, Loading-Modules, Job-Submissions, Interactive-Jobs, and Logging-in.
- Clean up rmacc folder and remove obsolete images.

Automation and Scripting Enhancements

Scripts and Tools
- Create a Python script for generating SVG flowcharts from dot files.
- Develop a script to check tab references and integrate it into the Makefile and RTD yaml.
- Develop a script to check dot file references and integrate it into the Makefile and RTD yaml.
Graph and Flowchart Improvements
- Adjust color schemes and dimensions for flowcharts, ensuring SVGs are responsive.
- Enhance flowchart generation with a Python script to clean generated SVGs.
- Add all necessary requirements to conf.py and RTD yaml

Content Adjustments

Content Organization
- Reorganize the FAQ page for clarity (partially addresses Consolidate Frequently Asked Questions into one spot #377)
- Add all Duo content to FAQ page
Enhancements and Tips
- Add introductory paragraphs and tips across various pages to improve user experience.
- Update references to ensure they point to the correct sections.

…, add required install of graphviz to conda environment, add graphviz requirements to conf.py

…custom css for class on digraph

… and import the svg. This allows finer control. Also included is a Python script that strips title and xlink:title from the generated svg because it creates tooltips that are annoying.

…ght and width is 100 percent, add scg generation for cloud flowchart

…rainings below accessing RC resources in left column

…ub section

…ted.md to navigating_docs.md, put tip on logging in page that points to navigating curc docs page, remove duo node on HPC flowchart and replace it with Acknowledging CURC

…abs in logging-in.md with shpinx-design tabs, remove RMACC page and link to rmacc tab in logging-in.md, modify conf.py, custom.css, and conda_dev_env.yml so they incorporate new tabs, protoype check_tab_ref.py for checeking that tab references exist

…tory for landing page images and put the meet user support image in it

…mages, reference said images appropriately

…ing_images, lower case all .PNG items

…a tip admonition

…e amc-access.md to additional-resources/amc_ssh_auth.md and modify index and references accordingly

…URC resources topics, create acknowledge CURC page and put it under the getting started section

…move over duo images to faq_images, remove unused FAQ directory, download putty-1/2.png images into interactive_jobs_images and reference them instead of the github link

…nd duo help for each institution on loging in page, make tabs on FAQ page fit format

…urces and remove it from landing page, fix grammar in logging-in page tips

…to this directory

…Makefile

…_ref.py describing what the script does

…logging-in pages

…ADME.md for flowcharts

…hart so that it can be used across the documentation, modify custom css names so they refer ro doc-flowchart class, finish README.md for graphviz flowcharts

…search bar from highlighting as pink

docs/getting_started/navigating_docs.md

docs/index.md

docs/getting_started/navigating_docs.md

docs/getting_started/logging-in.md

SchneiderCode

I added a few word changes, but the only major change was resolving a broken external link. At some point the CSU "Getting Started with Alpine" link changed - I added in the new link.

Co-authored-by: Michael Schneider <m.schneider.programmer@gmail.com>

b-reyes added 30 commits October 11, 2024 16:32

create getting started page, add initial flowcharts for HPC and Cloud…

ba3d4ae

…, add required install of graphviz to conda environment, add graphviz requirements to conf.py

add transparent background to digraph, provide class to digraph, set …

6dccf40

…custom css for class on digraph

push changes to see if transparent background works with RTD rendering

51c5f36

instead of using graphviz directly in markdown generate svg using dot…

e9e0c61

… and import the svg. This allows finer control. Also included is a Python script that strips title and xlink:title from the generated svg because it creates tooltips that are annoying.

modify color scheme for flowcharts, modify produced svgs so their hei…

1749102

…ght and width is 100 percent, add scg generation for cloud flowchart

change node color for light mode to black/white for flowcharts

3ed042f

add intro paragraphs to getting started page and modify hpc flowchart

a7aadef

move getting started and faq page into accessing RC resources, move t…

112c82f

…rainings below accessing RC resources in left column

reformat the logging in page and work on the getting a CURC account s…

5b3d4b0

…ub section

rename first heading in index to Getting Started, rename getting_star…

15f4aa5

…ted.md to navigating_docs.md, put tip on logging in page that points to navigating curc docs page, remove duo node on HPC flowchart and replace it with Acknowledging CURC

remove rmacc folder holding pngs as they are no longer used

13409fb

move current-sem-trainings.md under the access folder, create a direc…

7874301

…tory for landing page images and put the meet user support image in it

remove unused Logging-in directory

4b685bf

remove unused directory Interactive-Jobs

94a3a8f

remove unused Job-Submissions directory

9efedb2

move File-Transfers directory under compute and rename it to globus_i…

39b2f81

…mages, reference said images appropriately

remove unused Loading-Modules directory

5d0ac87

remove unused Templates directory

f1ab325

remove unused XSEDE directory

dbebf86

move Petalibrary folder to storage/petalibrary and rename it to mount…

04a6306

…ing_images, lower case all .PNG items

change current-sem-trainings.md tabs to new format and make sentence …

9a0feca

…a tip admonition

move amc-access-images under additional-resources/amc_ssh_images, mov…

cd9c339

…e amc-access.md to additional-resources/amc_ssh_auth.md and modify index and references accordingly

reorganize FAQ page so it is less overwhelming and has sections for C…

453b111

…URC resources topics, create acknowledge CURC page and put it under the getting started section

move over a majority of the duo page items into the Duo FAQ section, …

c3eb5db

…move over duo images to faq_images, remove unused FAQ directory, download putty-1/2.png images into interactive_jobs_images and reference them instead of the github link

put last duo item under FAQ section, remove Duo page, add where to fi…

68380cc

…nd duo help for each institution on loging in page, make tabs on FAQ page fit format

move courses using rc resources to its own page under additional reso…

bf4f59a

…urces and remove it from landing page, fix grammar in logging-in page tips

rename access directory to getting_started and modify all references …

ef20798

…to this directory

complete Python script for checking tab references and add it to the …

17bf526

…Makefile

do incorrect tab reference to make sure it is caught

2f52212

b-reyes added 9 commits November 1, 2024 14:43

rename containerization.md to containerization2.md

bbd8fe6

rename containerization2.md to containerization.md

8a62042

put in incorrect reference in cloud flowchart for testing purposes

4d89460

fix purposeful incorrect ref in cloud flowchart, comment on check_dot…

023eecb

…_ref.py describing what the script does

make small improvements to grammar and admonition content on faq and …

58f94e6

…logging-in pages

rename igraphviz_flowcharts to graphviz_flowcharts, begin creating RE…

c92f74a

…ADME.md for flowcharts

make dot flowchart files have doc-flowchart class instead of gs-flowc…

2bf9be0

…hart so that it can be used across the documentation, modify custom css names so they refer ro doc-flowchart class, finish README.md for graphviz flowcharts

make --pst-color-accent cu boulder gold when in dark mode to prevent …

45b3c2c

…search bar from highlighting as pink

Merge branch 'main' into add-flow-chart

4c1fe3c

b-reyes marked this pull request as ready for review November 1, 2024 22:47

remove indent for bullets in item 4 of README.md in graphviz directory

bce7741