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

Add Documentation for general operations #13

Open
6 tasks
tangkong opened this issue Aug 27, 2021 · 1 comment
Open
6 tasks

Add Documentation for general operations #13

tangkong opened this issue Aug 27, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@tangkong
Copy link
Owner

As a higher level package, this is probably a good place to organize best practices for every beamline. Possibly also basic Bluesky tutorials / commands.

Items to address:

  • Bring over auto-documentation from 1-5, 2-2 templates
  • Database configuration (initialization, databroker config file locations, backup and restore?)
  • Typical startup and shutdown procedures (new db creation? db export and file packaging? Metadata configuration?)
  • ssrltools package contents? Auto-docstring help?
  • References to beamline specific packages
  • Links to bluesky documentation, etc
@tangkong tangkong self-assigned this Aug 30, 2021
@tangkong tangkong added the documentation Improvements or additions to documentation label Aug 30, 2021
@tangkong
Copy link
Owner Author

tangkong commented Sep 2, 2021

Be wary of what exactly is in scope for a publicly visible document... Possibly move startup procedures somewhere else?

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

No branches or pull requests

1 participant