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

Documentation improvement for interLink integration #239

Open
esparig opened this issue May 31, 2024 · 1 comment · Fixed by #242
Open

Documentation improvement for interLink integration #239

esparig opened this issue May 31, 2024 · 1 comment · Fixed by #242

Comments

@esparig
Copy link
Member

esparig commented May 31, 2024

Regarding this document: https://github.com/grycap/oscar/blob/master/docs/interlink_integration.md

I suggest some improvements:

  • Replace Interlink with interLink, as the authors prefer.
  • Replace "HPC Vega" with "Remote host" in the image to generalize.
  • The sentence "Once the Virtual node and OSCAR are installed correctly, you use this node by adding the name of the virtual node in the InterLinkNodeName variable. Otherwise, to use a normal node of the Kubernetes cluster, let in blank """ is not clear, indicate where the InterLinkNodeName variable should be. I would add a code example for clarification (a service description, maybe?).
  • In general, only capitalize proper nouns and words at the beginning of a sentence, so in "Annotations, Restrictions, and other things to keep in mind." Restrictions should be restrictions.
  • Please clarify the following sentence: "The OSCAR services annotations persist in the virtual node and affect the behavior of the offload jobs."
  • Regarding the section "Annotations, Restrictions, and other things to keep in mind." I think it would make sense to use a list of items here or write it as an FAQ since, currently, there are many different things in one section.
  • where it reads "As a reminder, Interlink uses singularity to run a container with this characteristic" should say "As a reminder, interLink uses singularity to run a container with these characteristics".
@esparig
Copy link
Member Author

esparig commented Jun 4, 2024

After the #242 PR, some issues have been addressed, and the updated list of suggestions is now:

  • Replace Interlink with interLink, as the authors prefer. Please, replace all the occurrences.
  • Replace "HPC Vega" with "Remote host" in the image to generalize.
  • The sentence "Once the Virtual node and OSCAR are installed correctly, you use this node by adding the name of the virtual node in the InterLinkNodeName variable. Otherwise, to use a normal node of the Kubernetes cluster, let in blank """ is not clear, indicate where the InterLinkNodeName variable should be. I would add a code example for clarification (a service description, maybe?).
  • In general, only capitalize proper nouns and words at the beginning of a sentence, so in "Annotations, Restrictions, and other things to keep in mind." Restrictions should be restrictions.
  • Please clarify the following sentence: "The OSCAR services annotations persist in the virtual node and affect the behavior of the offload jobs."
  • Regarding the section "Annotations, Restrictions, and other things to keep in mind." I think it would make sense to use a list of items here or write it as an FAQ since, currently, there are many different things in one section.
  • where it reads "As a reminder, Interlink uses singularity to run a container with this characteristic" should say "As a reminder, interLink uses singularity to run a container with these characteristics".

Please, @catttam re-open this issue if you see fit.

@catttam catttam reopened this Jul 30, 2024
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 a pull request may close this issue.

2 participants