Add docs on how to queue some basic plans

Open Beginner friendly
#39 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with the existing documentation on getting things running locally and trace how basic plans are queued. Add documented examples for queuing a few basic plans, then verify that the examples are sufficient for someone following the local setup instructions.

Written by the indexing model from the issue text.

Description

The docs on getting things running locally are good but it would be good to expand them to show how we can do a few things.

Acceptance Criteria

  • Docs have some examples on queuing some plans etc.
Dominant language
Python
Stars
0
Forks
1
Avg merge
1d 7h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiamondLightSource/daq-queuing-service

All issues in DiamondLightSource/daq-queuing-service

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.