feat(scheduler): add init scheduler documentation - #998
Conversation
yoganandaness
left a comment
There was a problem hiding this comment.
Great job and a much needed one. It has come up really well.
There are few things, that i felt could be improved. Kindly revert if you have any counter arguments.
|
@alexyvanot By the way, are you also planning to include the technical documentation(Developer Guide) as well? As you might be aware of, the User Office Scheduler needs a bit of configuration setup to get it up and seamlessly interact with User Office Core. |
…t/user-office-core into documentation-scheduler
|
No, it's not currently planned to include the technical documentation at this time. However, this may change depending on further directives. I will check on this and get back to you with an update. |
|
Hi @alexyvanot, I removed myself from the PR as I see @yoganandaness had some very good points which overlapped with my observations, no additional comments from my side |
|
Hello @alexyvanot, This PR is very valuable and it seems we just need a one last push to get it in. If you need any help with some of the last remaining comments, feel free to point me at them and I'll try my best to help. |
…ges to enhance understanding
…ndardize section dividers and enhance readability
… and improve descriptions
…d clarity and presentation
…t/user-office-core into documentation-scheduler
|
@yoganandaness I have adjusted the documentation to address the comments you made. Also reworked the images so they are less blurry. Please have a look and maybe we can get this merged. Would be a great addition to the documentation we need. |
Description
This PR introduces the first version of the documentation for the scheduler.
It includes a set of images and a detailed guide explaining the functionality of the scheduler.
The scheduler section is added to the
mkdocs.ymlto integrate it into the documentation menu.Motivation and Context
This change is required to provide clear and comprehensive documentation for the scheduler feature, which is essential for users and developers working with the User Office Project. This is part of a collaboration between ESS (European Spallation Source) and Synchrotron SOLEIL, where I am currently completing an internship in computer engineering. The scheduler is an important tool for managing user experiments, and this documentation will help improve accessibility and understanding of the tool for everyone involved in the project.
How Has This Been Tested
I tested the changes by running
mkdocs servelocally to preview the updated documentation and deployed it into the Synchrotron SOLEIL test environnement using docker. I checked the layout of the images and confirmed that the scheduler section appears correctly in the documentation menu.Fixes
This PR addresses the lack of scheduler documentation and provides necessary visual aids.
It does not fix a specific issue but enhances the project's documentation overall.
Changes
documentation/docs/assets/images/folder.scheduler.mdfile underdocumentation/docs/user-guide/.documentation/mkdocs.ymlto include the scheduler section in the documentation menu.Depends on
This PR does not depend on any other open PRs.
Tests included/Docs Updated?