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

Adoc export #3659

Merged
merged 4 commits into from
May 4, 2022
Merged

Adoc export #3659

merged 4 commits into from
May 4, 2022

Conversation

dragonchaser
Copy link
Member

@dragonchaser dragonchaser commented May 3, 2022

This PR adds support for generating adoc files for the environment variables for consumption in the docs.
Version information is still missing (but prepared) and needs to be annotated with the variables and output needs to be added to the template.

/cc @mmattel

Refs #3583

@update-docs
Copy link

update-docs bot commented May 3, 2022

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

@ownclouders
Copy link
Contributor

💥 Acceptance test Core-API-Tests-ocis-storage-2 failed. Further test are cancelled...

@dragonchaser dragonchaser force-pushed the add-adoc-export branch 3 times, most recently from 78c0a4d to 55a708b Compare May 4, 2022 07:18
Signed-off-by: Christian Richter <crichter@owncloud.com>
@dragonchaser dragonchaser marked this pull request as ready for review May 4, 2022 09:09
docs/templates/ADOC.tmpl Outdated Show resolved Hide resolved
@mmattel
Copy link
Contributor

mmattel commented May 4, 2022

I would add the version field as it was in the original - even it will not get populated automatically atm (no generation code, no field in the go code), but it will force us to make this happen as the field is visible...
You may also, for the time being, add a default value like +1.20.0 (or whatever the beta version will be) as done in the original adoc file.

Signed-off-by: Christian Richter <crichter@owncloud.com>
Signed-off-by: Christian Richter <crichter@owncloud.com>
@butonic
Copy link
Member

butonic commented May 4, 2022

@dragonchaser how can I test this?

@dragonchaser
Copy link
Member Author

dragonchaser commented May 4, 2022

@butonic

goto docs/helpers
run: go run configextractor.go

@dragonchaser
Copy link
Member Author

I would add the version field as it was in the original - even it will not get populated automatically atm (no generation code, no field in the go code), but it will force us to make this happen as the field is visible... You may also, for the time being, add a default value like +1.20.0 (or whatever the beta version will be) as done in the original adoc file.

this is already prepared, just not output in the template to avoid confusion

@mmattel mmattel requested a review from butonic May 4, 2022 11:37
Copy link
Contributor

@mmattel mmattel left a comment

Choose a reason for hiding this comment

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

LGTM

@dragonchaser dragonchaser merged commit a3c4a9d into master May 4, 2022
@delete-merged-branch delete-merged-branch bot deleted the add-adoc-export branch May 4, 2022 12:40
ownclouders pushed a commit that referenced this pull request May 4, 2022
Merge: 8bfb589 9d7c9d3
Author: Christian Richter <1058116+dragonchaser@users.noreply.github.com>
Date:   Wed May 4 14:40:05 2022 +0200

    Merge pull request #3659 from owncloud/add-adoc-export

    Adoc export
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.

4 participants