Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

Move installation, configuration, etc. to doc/ and link over there. #76

Closed
dnsmichi opened this issue Jun 6, 2017 · 1 comment
Closed

Move installation, configuration, etc. to doc/ and link over there. #76

dnsmichi opened this issue Jun 6, 2017 · 1 comment
Assignees
@dnsmichi
Labels
Documentation
Milestone
1.1.10

Comments

@dnsmichi
Copy link
Collaborator

dnsmichi commented Jun 6, 2017

I'm thinking about the following structure

  • 01-About.md
  • 02-Installation.md
  • 03-Configuration.md
  • 10-Advanced.md
  • 11-Grafana.md

or similar.

This allows us to keep the README.md file clean.

Expected Behavior

Clean documentation structure which allows for enhancements and community patches.

Current Behavior

README.md is a bit bloated.

Possible Solution

Introduce doc/ and look into Icinga 2's documentation.

Further we can add mkdocs for quick documentation edits and local tests.
This can be added to CONTRIBUTING.md then too.
@dnsmichi dnsmichi mentioned this issue Jun 6, 2017
Closed
@dnsmichi
Copy link
Collaborator Author

dnsmichi commented Jun 6, 2017

I'll come up with a PR once in a while.

@dnsmichi dnsmichi self-assigned this Jun 12, 2017
@Mikesch-mp Mikesch-mp added this to the 1.1.8 milestone Jun 19, 2017
@Mikesch-mp Mikesch-mp modified the milestones: 1.1.8, 1.2.0 Jul 11, 2017
@Mikesch-mp Mikesch-mp modified the milestones: 1.1.10, 1.2.0 Aug 11, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@dnsmichi dnsmichi

Labels
Documentation
Projects
None yet
Milestone
1.1.10
Development

No branches or pull requests
2 participants
@dnsmichi @Mikesch-mp