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

Doc restructuration #6

Merged
merged 5 commits into from
Nov 14, 2022
Merged

Conversation

benoitblanc
Copy link
Member

Hi,

As I mentionned in issue #5 , I would like to help to enhance the documentation.

In this first PR, I propose to restructure documentation by creating different sections :

For now, there is only Installation section because READMEs of qwc-services contain installation/deployment/configuration instrucitons.

Then, we could add more docs on repos for User guide and Administration guide and pull it to this documentation.

What do you think about it ?

Thanks

@benoitblanc benoitblanc requested review from pka and tpo November 4, 2022 08:05
@pka
Copy link
Member

pka commented Nov 10, 2022

I'm fine with your ideas. Just thinking about wording. I slightly prefer "setup" over "installation" and maybe "Knowledge Base" instead of "How to"?

Thanks a lot for improving the Makefile! We can also merge and rename things afterwards.

@@ -1,10 +1,11 @@
+++
title = "LDAP Authentication Service"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the title not required?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, with Hugo-theme-learn you can define menuTitle that will be used in page's menu entry.

You don't need to define title (not required in Hugo) because it will be retrieved from all READMEs (in Makefile), so we don't need to remove duplicate title as in commit 06145f023a735e42193c6fdc15c50cfaa50573d7 when we just want to update documentation.

@benoitblanc
Copy link
Member Author

@pka I have renamed Installation to Setup.

As other sections (How to, User guide, Admin guide) are not already created, we could rename with the right wording when it will be created 👍

@pka pka merged commit c815423 into qwc-services:main Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants