Improve documentation with Argo/GPT4o for data management #569
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
- Changed "Command line" to "Command-line" for consistency. - Changed "web-based" to lowercase for consistency. - Added commas for clarity in lists and complex sentences. 2. Fixed formatting issues: - Removed unnecessary backslashes in paths. - Added a line break after the "Getting Started" URL for better readability. 3. Clarified language: - Specified "SSH" in uppercase as it is an acronym. - Clarified the use of paths by removing unnecessary escape characters.
…ocal transfers of small files" for clarity. 2. Improved formatting: No changes were necessary as the formatting is already clear and concise.
…ttps://www.globus.org).This" to separate sentences. 2. Fixed grammar: Added a period at the end of the sentence in "Django Globus Portal Framework customized for a variety of different projects" for completeness. 3. Fixed grammar: Added a period at the end of the sentence in "users can access ACDC using their campus or institution federated username and passcode" for completeness.
…collection" and ensuring consistent use of terms like "guest collection" and "Globus". 2. Fixed formatting issues, such as ensuring consistent use of bullet points and headings. 3. Clarified instructions and descriptions for better readability and understanding. 4. Removed redundant or unclear statements to improve clarity. 5. Ensured consistent use of terminology and formatting throughout the document.
…d correcting verb forms. 2. Fixed formatting issues, including consistent use of punctuation and capitalization. 3. Clarified instructions and ensured consistency in the use of terms like "ALCF account" and "Eagle filesystem." 4. Added missing periods at the end of some bullet points for consistency. 5. Ensured that the use of code formatting for filenames and scripts is consistent throughout the document.
… punctuation for clarity. 2. Improved formatting: Added bash syntax highlighting for code blocks to enhance readability. 3. Clarified instructions: Added missing backticks around commands and corrected the phrasing for consistency. 4. Fixed broken link placeholder: Added a placeholder link for "Using Globus" to indicate where a link should be provided.
…d consistency. 2. Fixed formatting issues, including ensuring consistent use of spaces and punctuation. 3. Corrected the spelling of "collaborators" and "capabilities." 4. Added missing periods at the end of some sentences for consistency. 5. Clarified instructions for disabling the Transfer Agent in HSI. 6. Added a missing link reference for "Using Globus" to ensure the link is functional.
…or clarity. 2. Improved formatting: Changed "Following are descriptions" to "Below are descriptions" for better readability. 3. Added bash syntax highlighting to the command examples for consistency and readability. 4. Corrected a repeated acronym: "ALCC/ALCC" to "ALCC/ESP" in the Quota Increases section.
…r punctuation. 2. Corrected the formatting of the table under "Polaris SSD Specs" to ensure proper alignment. 3. Added bash syntax highlighting to code blocks for better readability. 4. Clarified some sentences for improved understanding, such as specifying paths with backticks for consistency.
felker
reviewed
Jan 10, 2025
felker
reviewed
Jan 10, 2025
felker
reviewed
Jan 10, 2025
felker
reviewed
Jan 10, 2025
felker
approved these changes
Jan 11, 2025
There was a problem hiding this comment.
The LLM likes to remove commented-out text <!-- ..., which might not always be a desired outcome, e.g. throughout docs/data-management/acdc/eagle-data-sharing.md, it removed these HTML comments, including for example:
<!--- There are two ways for a PI to access their project directory on Eagle.
1. **Web Interface:** By logging in to Globus interface directly and navigating to the ALCF Eagle endpoint. -->
...
<!---
<figure markdown>
{ width="700" }
<figcaption>File Manager</figcaption>
</figure>
2. **POSIX:** By logging in to the ALCF systems from the terminal window.
<figure markdown>
{ width="700" }
<figcaption>Terminal Window</figcaption>
</figure> --->
just something to note for now; I let it remove them
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 data management. See issue #563.