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

docs: Add Docserv² AsciiDoc docs #279

Merged
4 commits merged into from
Jan 11, 2022
Merged

docs: Add Docserv² AsciiDoc docs #279

4 commits merged into from
Jan 11, 2022

Conversation

ghost
Copy link

@ghost ghost commented Jan 3, 2022

@tomschr Hi. Could please review these configuration docs?

For your reading pläscha, also uploaded to https://opensuse.github.io/docserv/

@ghost ghost requested a review from tomschr January 3, 2022 16:56
@ghost ghost force-pushed the feature/docs branch from 82fa074 to 2d46d92 Compare January 3, 2022 17:02
@ghost ghost requested a review from janajaeger January 3, 2022 17:03
@ghost ghost force-pushed the feature/docs branch 5 times, most recently from 208e95e to 7a8f033 Compare January 3, 2022 22:48
Copy link
Contributor

@tomschr tomschr left a comment

Choose a reason for hiding this comment

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

@sknorr Thanks for writing down all of docserv². Much appreciated! ❤️
I found some smaller issues, nothing serious. Hope you find them useful.

@ghost ghost force-pushed the feature/docs branch 4 times, most recently from 9b819b7 to f2cb8a4 Compare January 10, 2022 11:02
@ghost ghost force-pushed the feature/docs branch 3 times, most recently from 8504817 to 8d797b5 Compare January 10, 2022 18:22
@ghost
Copy link
Author

ghost commented Jan 10, 2022

@tomschr Mind going over this another time? I have added a bunch of new content too (installing, backups, API) and I think we should be suitably close to this being mergable. URL is still https://opensuse.github.io/docserv/.

@ghost ghost force-pushed the feature/docs branch 2 times, most recently from 28ed7bc to 6bffaef Compare January 10, 2022 19:21
@ghost ghost changed the title docs: Add first shot at Docserv² configuration docs docs: Add Docserv² AsciiDoc docs Jan 10, 2022
@ghost ghost force-pushed the feature/docs branch 2 times, most recently from ffd9a9d to a607294 Compare January 11, 2022 10:13
Copy link
Contributor

@tomschr tomschr left a comment

Choose a reason for hiding this comment

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

@sknorr Thanks for your efforts! Great work! 👍

I looked through it. Found some minor things and added some questions. Some are a matter of taste. Hope it helps.

Comment on lines +63 to +65
Replace `__[TARGET]__`, `__[PRODUCT]__`, `__[DOCSET]__`, `__[LANGUAGE_CODE]__`, `__[HOST]__`, and `__[PORT]__` with appropriate values.
You can combine multiple build instructions into a single `POST` requests by sending a data field with multiple JSON objects separated with comma characters (`,`).

Copy link
Contributor

Choose a reason for hiding this comment

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

Could you add an example call with curl?

Copy link
Author

Choose a reason for hiding this comment

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

I mean, there is an example right above...l.56 to 61.

@ghost ghost force-pushed the feature/docs branch from 1bb50f4 to 0669e99 Compare January 11, 2022 14:38
Stefan Knorr and others added 4 commits January 11, 2022 15:39
Invoking `docserv docserv` every single time is really confusing.
`docserv my-site` seems much better.
The example config had last been updated for Docserv² 3.x and even then
was not complete.
Sorry for the huge commit. Suddenly everything was dependent on each
other. :/

Co-authored-by: Tom Schraitle <[email protected]>
Co-authored-by: Quang Tran <[email protected]>
@ghost ghost force-pushed the feature/docs branch from 0669e99 to 8509725 Compare January 11, 2022 14:39
@ghost ghost merged commit 8509725 into main Jan 11, 2022
@ghost
Copy link
Author

ghost commented Jan 11, 2022

Thank you for reviewing! Despite the one semi-open question about the curl example, I have taken the liberty of merging it all.

@tomschr tomschr deleted the feature/docs branch January 12, 2022 09:44
This pull request was closed.
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