Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorganize documentation - add github pages #467

Merged
merged 6 commits into from
Aug 5, 2022
Merged

Conversation

erwindon
Copy link
Owner

@erwindon erwindon commented Aug 4, 2022

Is your feature request related to a problem? Please describe.
Currently, all documentation is in one big README.md file.
This also mixes installation instructions, feature descriptions and release history.

Describe the solution you'd like
Continue on PR #455 to:

  • separate the sections
  • make the documentation available in github pages.
  • provide the link to the documentation within SaltGUI

Describe alternatives you've considered

  1. separate sections and generate pages locally
    this complicates the release procedure and does not make the documentation globally accessible. therefore this alternative is rejected.

Additional context

@erwindon erwindon self-assigned this Aug 3, 2022
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 20:16 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 20:21 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 20:22 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 20:25 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:28 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:31 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:33 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:34 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:38 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:41 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:44 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:45 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:53 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:57 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 21:59 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 22:45 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 4, 2022 23:01 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 5, 2022 08:08 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 5, 2022 09:42 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 5, 2022 10:36 Inactive
@erwindon erwindon changed the title reorganize documentation reorganize documentation - add github pages Aug 5, 2022
@erwindon
Copy link
Owner Author

erwindon commented Aug 5, 2022

this PR will be limited to making the README.md file visible as a github-page.

  • move all documentation to directory docs
  • setup GitHub to use directory docs to generate the github-page (first on this branch, later on master, see https://github.com/erwindon/SaltGUI/settings/pages)
  • add icon to SaltGUI page header, which links to the github-page

to do in a new PR:

  • create separate section for (now reduced) README.md file, the user manual section and the release history section. include an index; and
  • add add other files (CONTRIBUTING.md, LICENSE.md and PERMISSIONS.md), update index to match; and
  • separate the use manual section into chapters for each page. update the index to match; and
  • update the documentation icon on each page to use a relevant deep-link into the documentation.
    see also reorganize documentation - additional improvements #469

@github-pages github-pages bot temporarily deployed to github-pages August 5, 2022 22:29 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 5, 2022 22:30 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 5, 2022 22:36 Inactive
@github-pages github-pages bot temporarily deployed to github-pages August 5, 2022 22:38 Inactive
@sonarqubecloud
Copy link

sonarqubecloud bot commented Aug 5, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@erwindon erwindon merged commit a59989d into master Aug 5, 2022
@erwindon erwindon deleted the github-pages branch August 5, 2022 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant