-
Notifications
You must be signed in to change notification settings - Fork 30
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
Improve documentation for account and project management with Argo/GPT4o #567
Open
keceli
wants to merge
22
commits into
main
Choose a base branch
from
keceli_fix_argo_account
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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
…or leadership computing preparation" for clarity. 2. Corrected formatting: Changed "Computes" to "Compute" to match singular form with the item listed.
…se and subject-verb agreement. 2. Fixed punctuation issues, such as adding commas for clarity and correcting the use of semicolons. 3. Improved formatting by adding code block syntax highlighting for commands to enhance readability. 4. Clarified some sentences for better understanding, such as specifying the context of examples and notes. 5. Corrected minor typographical errors, such as missing spaces and incorrect capitalization.
…first paragraph for better sentence flow. 2. Fixed grammar: Changed "provides insight on how many hours" to "provides insight into how many hours" for correct preposition usage.
…lural forms and capitalization. 2. Improved formatting: Added backticks around command-line options and field names for clarity. 3. Enhanced readability: Used consistent punctuation and spacing for better readability.
…ross" and "where" to "were." 2. Improved formatting: Added bash syntax highlighting for command examples for better readability. 3. Fixed formatting issues: Ensured consistent spacing and alignment in tables and lists. 4. Clarified notes: Improved clarity in notes and explanations for better understanding.
…ginning of each option description for consistency and capitalization. 2. Fixed formatting issues: Added missing line breaks between command options for better readability. 3. Clarified descriptions: Added periods at the end of each option description for consistency. 4. Corrected the description for `-O --get-only-inactive` to specify "Include only inactive allocations" for clarity.
…d capitalization. 2. Improved formatting by adding backticks around command-line options and arguments for clarity. 3. Ensured consistent use of terms like "ID" and "date entry" for uniformity. 4. Added periods at the end of list items and option descriptions for consistency.
…ization for consistency (e.g., "Show program's version number" to "Show the program's version number"). 2. Improved formatting: Used backticks for command-line options and placeholders to enhance readability. 3. Clarified instructions: Added emphasis on not mixing names and IDs for certain options. 4. Ensured consistent punctuation and spacing throughout the document.
…ingular subjects and capitalizing the first word in sentences. 2. Improved formatting by ensuring consistent use of backticks for command-line options and parameters. 3. Clarified instructions and descriptions for better readability and understanding. 4. Ensured consistent punctuation and capitalization throughout the document.
… option description for consistency. 2. Fixed formatting issues: Added missing line break before "jobs" in the COMMANDS section for clarity. 3. Improved clarity: Added periods at the end of each option description for consistency and readability.
…d punctuation in option descriptions. 2. Improved formatting: Used backticks for inline code elements to enhance readability and clarity.
…sentences for consistency. 2. Fixed formatting issues: Ensured consistent use of backticks for command-line options and parameters to improve readability. 3. Removed duplicate numbering in the "Notes" section. 4. Clarified some option descriptions for better understanding.
2. Corrected capitalization for consistency (e.g., "ID" instead of "id"). 3. Improved formatting by using backticks for inline code elements to enhance readability. 4. Clarified instructions and options by adding necessary punctuation and capitalization.
…sentences for consistency. 2. Fixed formatting issues: Ensured consistent use of backticks for command-line options and parameters. 3. Removed duplicate numbering in the "Notes" section. 4. Clarified language for better readability and consistency.
…al" for singular agreement, and capitalized the first letter of sentences. 2. Improved formatting: Added backticks around command-line options and placeholders for better readability and consistency. 3. Clarified instructions: Added punctuation and clarified some instructions for better understanding.
2. Fixed a grammatical error: changed "at the links on the bottom of this page" to "at the links at the bottom of this page" for clarity.
…ubmit questions" for clarity. Added missing commas for better readability. 2. Fixed formatting issues: Ensured consistent use of punctuation and capitalization in lists and instructions. Added backticks around command examples for better readability. 3. Corrected a typo: Changed "receieved" to "received." 4. Removed an extra space in the "Facility Policies" link to ensure proper formatting.
…d consistency. 2. Fixed formatting issues, including ensuring consistent use of punctuation and capitalization. 3. Added bash syntax highlighting to code blocks for improved readability. 4. Corrected email formatting to ensure consistency and accuracy. 5. Clarified instructions and steps for better understanding.
…l language. 2. Corrected grammar: Changed "on a ALCF resource" to "on an ALCF resource" for proper article usage. 3. Corrected grammar: Changed "login" to "log in" for consistency in verb usage. 4. Added a period at the end of the sentence in the "Account Abilities" section for consistency in punctuation.
…ion for clarity. 2. Corrected grammar: Changed "3" to "three" for consistency in the section "How do I request a new project/allocation?" 3. Corrected grammar: Changed "What you have accomplished" to "What have you accomplished" for consistency in question format. 4. Corrected grammar: Changed "What you will do" to "What will you do" for consistency in question format. 5. Corrected grammar: Changed "What you are requesting" to "What are you requesting" for consistency in question format. 6. Corrected grammar: Changed "How many additional hours you are requesting" to "How many additional hours are you requesting" for consistency in question format. 7. Added a period after "join a project" for consistency in the section "How do I join a project?"
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.
Similar to earlier PRs (#562, #565), using Argo/GPT4o to improve the documentation for account and project management. See issue #563. Note that 12 of the files changed are not part of the documentation (the ones in
not_in_nav
), so they can be safely ignored in the PR if there is no plan to reuse them.