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

A glossary of terms for Parsl documentation #3578

Closed
wants to merge 0 commits into from

Conversation

Kanegraffiti
Copy link

This pull request addresses issue #3426 by adding a glossary of Parsl terms to the user guide and linking glossary terms throughout the first three sections of the User guide using citations.

Changes made:

  • Created glossary.rst in the user guide section.
  • Verified that the documentation builds successfully and all links work as expected by testing on the first 3 sections of the user guide.

Please review and let me know if further changes are needed.

@sophie-bui sophie-bui requested a review from WardLT August 9, 2024 19:26
Copy link
Collaborator

@sophie-bui sophie-bui left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Kanegraffiti – please implement the following updates:

  • Remove the numbers in front of terms. This will become tedious as we add more terms over time
  • Review terms and organize them alphabetically according to the English alphabet (For example: "DataFuture" should go after "DataFlowKernel")
  • Make sure the glossary directive is formatted according to these instructions to ensure we can link to the term throughout our docs

@WardLT
Copy link
Contributor

WardLT commented Aug 13, 2024

Should I still review this or wait until after you address Sophie's comments?

@Kanegraffiti
Copy link
Author

Should I still review this or wait until after you address Sophie's comments?

In this new PR, I have addressed @sophie-bui comments. Please review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants