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

Reorganize Aurora > Compiling and Linking; Example Program and Makefile page especially needs update #800

Open
3 tasks
felker opened this issue Mar 14, 2025 · 0 comments
Assignees
Labels
content Improvements or additions to documentation content organization where to place/split/replicate .md content; nav menu dropdown and folder hierarchy style subjective design choices, language conventions, how and when to use mkdocs & theme features

Comments

@felker
Copy link
Member

felker commented Mar 14, 2025

discussed with @cjknight on Slack

https://docs.alcf.anl.gov/aurora/compiling-and-linking/aurora-example-program-makefile/

Just renamed ./set_affinity_gpu_sunspot.sh script in b795ad7 in #795, but it is unclear what is old content, or redundant content with https://docs.alcf.anl.gov/aurora/running-jobs-aurora/, and it seems we need more info on compiling and linking. The Running Jobs on Polaris (barely mentioning compiling; more detail on task binding and affinity)
vs. Example Programs and Makefiles for Polaris (faster survey of different use cases: CPU OpenMP vs. GPU OpenMP vs. ...) content division is similar, but more clear-cut.

Related #614

  • Move Aurora > Build Tools > CMake (only page in Build Tools dropdown) to Compiling and Linking dropdown?
  • In Example Programs and Makefiles for Polaris page, there are compile commands that are useful, but not a single Makefile. Rename this and the Aurora page?
  • We still could use separate pages on each of the compiler families:

    user-guides/mkdocs.yml

    Lines 476 to 478 in 1fd2be6

    aurora/compiling-and-linking/llvm-compilers-aurora.md
    aurora/compiling-and-linking/gnu-compilers-aurora.md
    aurora/compiling-and-linking/cce-compilers-aurora.md
@felker felker added content Improvements or additions to documentation content style subjective design choices, language conventions, how and when to use mkdocs & theme features labels Mar 14, 2025
felker added a commit that referenced this issue Mar 14, 2025
Found when thinking about #800

See #652
@felker felker pinned this issue Mar 14, 2025
@felker felker added the organization where to place/split/replicate .md content; nav menu dropdown and folder hierarchy label Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to documentation content organization where to place/split/replicate .md content; nav menu dropdown and folder hierarchy style subjective design choices, language conventions, how and when to use mkdocs & theme features
Projects
None yet
Development

No branches or pull requests

2 participants