Streamlining terminology in docs #240
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scheibelp
requested changes
May 22, 2024
There was a problem hiding this comment.
IMO it would be worth putting the high-level intent in the PR description: at least one of the high-level goals seems to be standardizing organization and naming of the subcomponents of benchpark:
- Benchmarks
- System specifications (originally called system configs)
- Experiments
Another appears to be reorganizing how-to information into a set of FAQ sub-pages (I have a comment that we might want to change the titles of these pages).
pearce8
added a commit
that referenced
this pull request
Oct 25, 2024
* docs: fix reference to current system specs file renamed in #240 * first draft of workflow, lots of overlap with existing docs * initial checkin of new docs * still needs updates but the overall flow is there * fix spelling error * updated a few more files * fix formatting * few more docs updates * more docs updates * Update docs for allocation modifier * added examples for experiment init * updated workflow figure * Some udpates to the validation steps * benchmark validation steps * updates site-specific configs * fix formatting * formatting fixes * more udpates * adding experiment instructions * fix version check command * rework table of contents, move legacy workflow to separate section * Reorg and updates, system example needed, container, why benchpark * typo in add a system * update index order * remove fugaku from main page * a few updates * updates to llnl tutorial * make note internal * System class: Adding Dane to CTS (#408) * adding Dane to CTS * add dryruns for all cts systems * fix typo * Bump actions/checkout from 4.2.1 to 4.2.2 (#409) Bumps [actions/checkout](https://github.com/actions/checkout) from 4.2.1 to 4.2.2. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@eef6144...11bd719) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Print status messages about bootstrapping (#410) Bootstrapping can take a while, provide some indication of activity to the user. * next up finish the x86 system example * Full x86 example * hide why benchpark page and fix typos * another typo * index cleanup - remove benchpark-help page, merged into another page - move benchmark suites page into running benchpark - rename suite of experiments page * fix unexpected indent warning * remove bad reference to page that doesn't exist * add a system: fix indent warning --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Stephanie Brink <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: pearce8 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Standardizing organization and naming of the subcomponents of Benchpark:
Reorganizing how-to information into a set of FAQ sub-pages.