opendevstack / ods-documentation

Antora playbooks to generate the versioned documentation
0 stars 6 forks source link

Remove or rename docs folder #47

Open michaelsauter opened 4 years ago

michaelsauter commented 4 years ago

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?

tbugfinder commented 3 years ago

I could create a PR for changing the folder name as docs is confusing. rendered or rendered_docs would be better.

tbugfinder commented 2 years ago

Github pages depends on the docs folder. There are options to use github actions for maintaining a dedicated branch for the github pages, though.

michaelsauter commented 2 years ago

If it isn't straight-forward, I would suggest to just close this issue as it isn't super important.

petergroft commented 2 years ago

Delete and Rename Files or Folders

  1. Click File Explorer icon.
  2. Go to the location where store your file or folder.
  3. Click the name of the file or folder you wish to delete.
  4. Press the delete key (on the keyboard) or right-click the file or folder and click Delete.

Regards, Peter