oscar
oscar copied to clipboard
grycap
Documentation improvement for interLink integration
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".
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 Please double-check if this can be merged / closed / requires additional info.
