canonical / canonical/microcloud
Microcloud docs: finding available features
- Dominant language
- Go
- Stars
- 532
- Forks
- 83
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 36
Description
*Please describe the question or issue you're facing with "Reference - MicroCloud documentation 2.1.3".*
When browsing the Microcloud documentation at https://canonical.com/microcloud/docs, I found it somehow difficult to learn about Microcloud's features. I was particularly interested in enhanced platform awareness capabilities, but I wasn't able to find any information. Two different ideas to (potentially) solve this problem:
- Add a features section, with the set of features grouped per category (e.g. "enhanced platform awareness" being a relevant category).
- Add configuration guides for this type of features, similarly to the Openstack documentation: https://canonical-openstack.readthedocs-hosted.com/en/latest/how-to/misc/configuring-sriov/
---
*Reported from: https://canonical.com/microcloud/docs/default/reference/
Contributor guide
Research direction
Start with the MicroCloud documentation at canonical.com/microcloud/docs, especially the Reference - MicroCloud documentation 2.1.3 entry point, and compare its discoverability with the linked OpenStack SR-IOV guide. First clarify whether the work is a categorized features section or configuration guides; done means enhanced platform awareness and other relevant capabilities are easy to find and understand.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100