-
Notifications
You must be signed in to change notification settings - Fork 3
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
Conversation
208e95e
to
7a8f033
Compare
There was a problem hiding this 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.
9b819b7
to
f2cb8a4
Compare
8504817
to
8d797b5
Compare
@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/. |
28ed7bc
to
6bffaef
Compare
ffd9a9d
to
a607294
Compare
There was a problem hiding this 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.
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 (`,`). | ||
|
There was a problem hiding this comment.
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
?
There was a problem hiding this comment.
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.
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]>
Thank you for reviewing! Despite the one semi-open question about the |
@tomschr Hi. Could please review these configuration docs?
For your reading pläscha, also uploaded to https://opensuse.github.io/docserv/