opendevstack / opendevstack/ods-documentation

Remove or rename docs folder

Open
#47 3 comments 0 reactions 1 assignee View on GitHub

@michaelsauter is already working on this.

Since Apr 20, 2020.

Dominant language
CSS
Stars
0
Forks
6
PR merge metrics
No merged PRs in 30d

Description

It is very confusing that this repo has a docs folder. In all other repos, the docs folder contain the documentation sources. Here, the docs folder contains the rendered documentation.

We should rename it, e.g. to rendered so that it becomes clear what is inside the folder.

Further, maybe we could even move the whole rendering elsewhere. I think it would be awesome if the rendered documentation would actually be pushed to the opendevstack.github.io repo, which is where the documentation lives.

@rattermeyer What are you thoughts on this?

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.