Reorganize documentation so that available modules are more easily visible
See original GitHub issueTitle: Reorganize documentation so that available modules are more easily visible
Description:
Describe your idea. Please be detailed. If a feature request, please describe the desired behavior, what scenario it enables, and how it would be used.
Our current (very thorough and beautiful 😁) readme has become very long and could benefit from being split up into different sections. It could help others better discover our tool if we made it easier to see at a glance what data Cartography pulls.
We can discuss this in more detail below but ideally we would have configuration and installation in docs/setup/
or something and all the other sections in their own folders under docs/
.
Issue Analytics
- State:
- Created 4 years ago
- Reactions:1
- Comments:5 (2 by maintainers)
Top Results From Across the Web
Modular documentation reference guide
This manual provides instructions on how to author modularly structured documentation based on user stories. The manual defines used ...
Read more >How do I add requirements to a module? - Canvas Community
Module requirements are displayed in the order that they exist as module items. You may need to reorder module items so that the...
Read more >Canvas: Decide How to Organize Your Course Content
The Module tool allows you to organize your course content (Pages, Assignments, Quizzes, etc.) for students to progress through a specific order.
Read more >How to Organize Technical Documentation [TEMPLATES]
Want better ways to organize, visualize and curate your technical documents? We've curated examples of the best documentation sites, ...
Read more >Python Modules and Packages – An Introduction
Maintainability: Modules are typically designed so that they enforce logical boundaries between different problem domains. If modules are written in a way that ......
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@marco-lancini I would love that, I think a section on possible deployment options could be helpful. The section wouldn’t be prescriptive, but it would provide helpful examples on how to use it in prod. We could link to your blog post, and we could also take elements of it and adapt it here. I’ll create a follow-up issue to do this.
What would you think of a setup similar to the one outlined in the following blog post? (section “Deployment on Kubernetes”)