Icinga / Icinga/get-started-docs

Remove doc/01.Introduction.md and doc/02.Scenarios.md

Open Beginner friendly
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
3
Forks
3
PR merge metrics
No merged PRs in 30d

Description

The two files doc/01.Introduction.md and doc/02.Scenarios.md seem to be outdated placeholders and are not linked from any of the other docs.

Nevertheless, they are published with the rest and appear when using the search option, https://icinga.com/docs/get-started/latest/doc/01.Introduction/; for example, when searching for "weird setups" 🙃

I would argue that they can be removed.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start with doc/01.Introduction.md and doc/02.Scenarios.md, then check the surrounding documentation for references to them. Confirm they are not linked elsewhere and verify the generated documentation no longer publishes or searches these pages. Done means both outdated placeholder files and their published entries are gone.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.