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.

Sign up for GitHub

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

Jump to bottom

Update the adoc.tmpl and regex go template for adoc #4103

Closed
wants to merge 1,822 commits into from
Closed

Update the adoc.tmpl and regex go template for adoc #4103

wants to merge 1,822 commits into from

Conversation

mmattel
Copy link
Contributor

@mmattel mmattel commented Jul 5, 2022 •
edited
Loading

Fixes: #4097 (Some env content provided does not make it into the documentation)

Adding the pass macro for those two cells is neccessary because the content are go slices (arrays) which would be interpreted differently in Antora.

IMPORTANT
We also need to remove the regex (@dragonchaser pls help with the file, I guess it is docs/helpers/adoc-generator.go.tmpl) in the default text the escaping of the http directive in the default value cell (description is fine). Currently we do http --> \http. With this PR, the regex applied would print \http in the default value cell...
We can check this when done with the env THUMBNAILS_DATA_ENDPOINT

phil-davis and others added 30 commits May 16, 2022 06:14
@phil-davis
commit ae4ec53
e9bc1ea 
Merge: 7b95b40 a033767
Author: Phil Davis <phil@jankaritech.com>
Date:   Mon May 16 11:57:48 2022 +0545

    Merge pull request #3794 from owncloud/bump-commit-id-20220513

    [tests-only] [full-ci] Bump commit id for API tests
@wkloucek
commit 6394ec2
3e93a00 
Merge: ae4ec53 44c909b
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon May 16 09:46:32 2022 +0200

    Merge pull request #3796 from wkloucek/unify-ocis-commands

    unify ocis subcommands
@wkloucek
commit 7a7a343
f79efd4 
Merge: 6394ec2 4b73b32
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon May 16 09:46:51 2022 +0200

    Merge pull request #3798 from wkloucek/app-provider-unused-transfer-secret

    remove unused transfer secret from app provider
@wkloucek
commit 922d141
8ff1829 
Merge: 008622e 97220e6
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon May 16 10:02:40 2022 +0200

    Merge pull request #3799 from wkloucek/fix-settings-idm-adminuserid

    fix settings and idm admin user id configuration
@kobergj
commit d30e70d
89d5ec3 
Author: kobergj <jkoberg@owncloud.com>
Date:   Mon May 16 11:07:00 2022 +0200

    [full-ci] Bump Reva version (#3779)

    * use custom reva to check changes

    Signed-off-by: jkoberg <jkoberg@owncloud.com>

    * don't query quota and children when space is disabled

    Signed-off-by: jkoberg <jkoberg@owncloud.com>

    * final touches

    Signed-off-by: jkoberg <jkoberg@owncloud.com>

    * update expected failures

    Signed-off-by: jkoberg <jkoberg@owncloud.com>

    * fix changelog typo

    Signed-off-by: jkoberg <jkoberg@owncloud.com>
@wkloucek
commit d3025ec
f4167ea 
Merge: e52baab a933b61
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon May 16 11:37:35 2022 +0200

    Merge pull request #3800 from wkloucek/fix-search-grpc-addr-env

    Bugfix: Rename the search extensions environment variable for the grpc server address
@micbar
commit 6a7fc50
c2a12ed 
Merge: 4a02fd8 3ce2c21
Author: Michael Barz <mbarz@owncloud.com>
Date:   Mon May 16 12:13:44 2022 +0200

    Merge pull request #3803 from wkloucek/un-compose-commons

    remove composition of Commons
@wkloucek
commit 61b9b6c
a092df6 
Merge: 6a7fc50 713bdfc
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon May 16 12:46:31 2022 +0200

    Merge pull request #3802 from wkloucek/fix-storage-users-config

    Bugfix: Fix multiple configuration environment variables for the storage-users extension
@wkloucek
commit 7eaad3d
562effe 
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon May 16 10:47:04 2022 +0000

    Automated changelog update [skip ci]
@micbar
commit cbd7ea7
95fee94 
Merge: 7eaad3d 3fbf6d3
Author: Michael Barz <mbarz@owncloud.com>
Date:   Tue May 17 13:51:00 2022 +0200

    Merge pull request #3807 from owncloud/bump-core-commit-id-20220517

    [tests-only] [full-ci] Bump CORE_COMMITID for tests
@rhafer
commit 944aded
1e939ef 
Author: Ralf Haferkamp <rhaferkamp@owncloud.com>
Date:   Mon May 9 11:50:25 2022 +0200

    Add docs for `/me/changePassword`
@rhafer
commit d0d9d20
ec3ce80 
Author: Ralf Haferkamp <rhaferkamp@owncloud.com>
Date:   Tue May 17 12:24:08 2022 +0000

    Automated changelog update [skip ci]
@rhafer
commit d0d9d20
64eedeb 
Author: Ralf Haferkamp <rhaferkamp@owncloud.com>
Date:   Tue May 17 12:24:08 2022 +0000

    Automated changelog update [skip ci]
@wkloucek
commit 1dee234
0752807 
Merge: d0d9d20 57c0de3
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Wed May 18 09:02:03 2022 +0200

    Merge pull request #3813 from wkloucek/fix-grap-deploymnts

    workaround ldaps insecure bind for graph #3812
@mmattel
commit c376db5
2cb7e17 
Merge: 1dee234 76ea987
Author: Martin <github@diemattels.at>
Date:   Wed May 18 10:15:34 2022 +0200

    Merge pull request #3817 from wkloucek/audit-log-out

    add comment about independence of log outputs
@butonic
commit 7da8fcf
866e85e 
Merge: c376db5 a99b526
Author: Jörn Friedrich Dreyer <jfd@owncloud.com>
Date:   Wed May 18 08:30:45 2022 +0000

    Merge pull request #3820 from rhafer/create-user-beta

    [docs-only] beta-testplan: Adjust curl examples to use graph instead of accounts/ocs
@mmattel
commit d4941d4
9e5d8fe 
Merge: 7da8fcf 7d87927
Author: Martin <github@diemattels.at>
Date:   Wed May 18 11:27:11 2022 +0200

    Merge pull request #3819 from wkloucek/debug-config-desc

    add descriptions to the debug config
@ScharfViktor
commit 16a9967
f739fb9 
Author: Viktor Scharf <scharf.vi@gmail.com>
Date:   Wed May 18 11:39:16 2022 +0200

    ApiTest. download files (#3809)

    * add tests download file

    * added ability to download different versions of files

    * fix after review
@ScharfViktor
commit 64df360
62d2cd0 
Author: Viktor Scharf <scharf.vi@gmail.com>
Date:   Wed May 18 12:43:12 2022 +0200

    beta-plan docs: change method creating user (#3822)
@mmattel
commit 4a3f7bc
8236f43 
Merge: 64df360 2d3c292
Author: Martin <github@diemattels.at>
Date:   Wed May 18 15:51:16 2022 +0200

    Merge pull request #3824 from kobergj/BringKatherineBack

    Bring katherine back
@mmattel
commit afb5d41
877070c 
Merge: 523f56c b893a81
Author: Martin <github@diemattels.at>
Date:   Wed May 18 15:52:34 2022 +0200

    Merge pull request #3816 from owncloud/doc-client-protocol

    [docs-only] add client protocol overview
@mmattel
commit b10270c
f0f6fd6 
Merge: afb5d41 6958533
Author: Martin <github@diemattels.at>
Date:   Wed May 18 16:32:57 2022 +0200

    Merge pull request #3827 from wkloucek/update-port-ranges-add-debug-config

    update port ranges add debug config
@mmattel
commit ea43544
31f1dc3 
Author: Martin <github@diemattels.at>
Date:   Wed May 18 14:34:05 2022 +0000

    Automated changelog update [skip ci]
commit 7b896ef
b75f12e 
Merge: ea43544 0893fcc
Author: Pascal Wengerter <pwengerter@owncloud.com>
Date:   Thu May 19 08:52:39 2022 +0200

    Merge pull request #3806 from owncloud/bump-settings-service-deps

    Bump prod deps of settings service UI
@butonic
commit b788552
19ba0eb 
Merge: 7b896ef f75616d
Author: Jörn Friedrich Dreyer <jfd@owncloud.com>
Date:   Thu May 19 07:37:41 2022 +0000

    Merge pull request #3821 from aduffeck/fix-file-uploaded-event

    Fix file uploaded event
@wkloucek
commit 5f4cd98
b639b83 
Merge: b788552 a861f9c
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Thu May 19 10:32:10 2022 +0200

    Merge pull request #3831 from wkloucek/proxy-config-revamp

    proxy config revamp
@ScharfViktor
commit bed3d9f
dc15008 
Author: Viktor Scharf <scharf.vi@gmail.com>
Date:   Thu May 19 11:05:36 2022 +0200

    add test with no restriction quota (#3814)
@phil-davis
commit 8ece455
0c5af09 
Merge: bed3d9f 582e050
Author: Phil Davis <phil@jankaritech.com>
Date:   Thu May 19 15:04:12 2022 +0545

    Merge pull request #3834 from owncloud/set-public-link-defaultname-capability

    Set public link defaultname capability
@wkloucek
commit 47b6904
9d8275e 
Merge: 8afbb70 ed79a20
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Thu May 19 13:19:22 2022 +0200

    Merge pull request #3836 from owncloud/fix-deployment-compose

    [deployments] Enclose boolean with string in docker-compose env
@butonic
commit 49cac99
d4e677e 
Merge: 47b6904 b596d1d
Author: Jörn Friedrich Dreyer <jfd@owncloud.com>
Date:   Thu May 19 12:25:13 2022 +0000

    Merge pull request #3833 from wkloucek/registry-cache

    introduce service registry cache
Pascal Wengerter and others added 20 commits June 29, 2022 15:15
commit ff8a916
4bba791 
Merge: 3d2dc3a 1a2ccfe
Author: Pascal Wengerter <pwengerter@owncloud.com>
Date:   Wed Jun 29 17:08:19 2022 +0200

    Merge pull request #4069 from owncloud/dependabot/npm_and_yarn/services/settings/babel/core-7.18.6

    Bump @babel/core from 7.15.5 to 7.18.6 in /services/settings
commit ff8a916
a7a621d 
Merge: 3d2dc3a 1a2ccfe
Author: Pascal Wengerter <pwengerter@owncloud.com>
Date:   Wed Jun 29 17:08:19 2022 +0200

    Merge pull request #4069 from owncloud/dependabot/npm_and_yarn/services/settings/babel/core-7.18.6

    Bump @babel/core from 7.15.5 to 7.18.6 in /services/settings
commit ff8a916
2bb5ba4 
Merge: 3d2dc3a 1a2ccfe
Author: Pascal Wengerter <pwengerter@owncloud.com>
Date:   Wed Jun 29 17:08:19 2022 +0200

    Merge pull request #4069 from owncloud/dependabot/npm_and_yarn/services/settings/babel/core-7.18.6

    Bump @babel/core from 7.15.5 to 7.18.6 in /services/settings
@phil-davis
commit 86f7366
e4d5086 
Merge: ff8a916 84124d7
Author: Phil Davis <phil@jankaritech.com>
Date:   Thu Jun 30 13:59:21 2022 +0545

    Merge pull request #4071 from owncloud/bump-commitid-20220630

    [tests-only] [full-ci] Bump commit id for tests
@phil-davis
commit 4e07dae
3690aa6 
Merge: 86f7366 6b5748e
Author: Phil Davis <phil@jankaritech.com>
Date:   Thu Jun 30 15:27:37 2022 +0545

    Merge pull request #4054 from owncloud/searchInProjectSpace

    ApiTest. search entity from project space and shares jail
@rhafer
commit 8578f4e
3d3d39e 
Author: Ralf Haferkamp <rhaferkamp@owncloud.com>
Date:   Tue Jun 28 12:39:42 2022 +0200

    graph: Add descriptions for LDAP related config settings
@rhafer
commit aa066c4
88d2b34 
Author: Ralf Haferkamp <rhaferkamp@owncloud.com>
Date:   Thu Jun 30 12:17:59 2022 +0000

    Automated changelog update [skip ci]
@wkloucek
commit a80c656
871738e 
Merge: aa066c4 8d11ba0
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Fri Jul 1 08:13:31 2022 +0200

    Merge pull request #4075 from rhafer/rm

    Remove unused OpenID connect middleware
@wkloucek
commit 74c66cd
0fcb9be 
Merge: a80c656 5aeaf29
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Fri Jul 1 08:50:48 2022 +0200

    Merge pull request #4066 from owncloud/dependabot/go_modules/github.com/stretchr/testify-1.8.0

    Bump github.com/stretchr/testify from 1.7.5 to 1.8.0
@mmattel
commit 6ec933c
81c0985 
Merge: 74c66cd 9b4c746
Author: Martin <github@diemattels.at>
Date:   Fri Jul 1 16:05:53 2022 +0200

    Merge pull request #4077 from wkloucek/config-descriptions-reloaded

    config descriptions reloaded
@mmattel
commit ebe20fa
f3c5600 
Author: Martin <github@diemattels.at>
Date:   Fri Jul 1 14:10:05 2022 +0000

    Automated changelog update [skip ci]
@mmattel
commit ebe20fa
16ffcca 
Author: Martin <github@diemattels.at>
Date:   Fri Jul 1 14:10:05 2022 +0000

    Automated changelog update [skip ci]
@mmattel
commit ebe20fa
81b5b0a 
Author: Martin <github@diemattels.at>
Date:   Fri Jul 1 14:10:05 2022 +0000

    Automated changelog update [skip ci]
@phil-davis
commit 25ca415
a29168d 
Merge: ebe20fa d6a0003
Author: Phil Davis <phil@jankaritech.com>
Date:   Mon Jul 4 14:08:03 2022 +0545

    Merge pull request #4083 from owncloud/individual-it-patch-1

    go 1.18 is required
@wkloucek
commit e41975b
77f1d64 
Merge: 6c7ca9e 627c79d
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon Jul 4 20:57:26 2022 +0200

    Merge pull request #4086 from wkloucek/mask-proxy-config-endpoint

    mask sensitive values in /config proxy debug server endpoint
@wkloucek
commit f1f3739
22f683c 
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Mon Jul 4 19:00:06 2022 +0000

    Automated changelog update [skip ci]
commit 0379171
799bc9e 
Merge: f1f3739 2f1cdfa
Author: David Christofas <dchristofas@owncloud.com>
Date:   Tue Jul 5 10:41:30 2022 +0200

    Merge pull request #4074 from owncloud/update-idp-ui

    [full-ci] Update idp UI
commit a9b66d4
bce134a 
Merge: b70f8de f02591b
Author: David Christofas <dchristofas@owncloud.com>
Date:   Tue Jul 5 10:56:36 2022 +0200

    Merge pull request #4093 from wkloucek/improve-startup-errors

    improve startup error logging
commit 41226de
0622514 
Merge: d75b4ad d1faa08
Author: David Christofas <dchristofas@owncloud.com>
Date:   Tue Jul 5 11:39:35 2022 +0200

    Merge pull request #4096 from owncloud/add-missing-env-var-descriptions

    Fix typo in variable description
@mmattel
Update ADOC.tmpl
fbcab85 
Fixes: #4097 (Some env content provided does not make it into the documentation)

Adding the `pass` macro for those two cells is neccessary because the content are go slices (arrays) which would be interpreted differently in Antora.
@mmattel mmattel requested a review from dragonchaser July 5, 2022 13:44
@update-docs
Copy link

update-docs bot commented Jul 5, 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.

@dragonchaser
Copy link
Member

@mmattel So basically this also fixes the escaped http issue we had before?

@dragonchaser
Copy link
Member

also: wrong branch (probably, this belongs into master)

@dragonchaser dragonchaser marked this pull request as draft July 5, 2022 14:14
@mmattel
Copy link
Contributor Author

mmattel commented Jul 5, 2022

@mmattel So basically this also fixes the escaped http issue we had before?

Caution, we need to escape http in the description. With pass it can be omitted for the default value.

@mmattel
Copy link
Contributor Author

mmattel commented Jul 5, 2022

also: wrong branch (probably, this belongs into master)

I thought this belongs to the docs branch, but I may be wrong...

@mmattel mmattel changed the base branch from docs to master July 5, 2022 16:16
@mmattel mmattel closed this Jul 5, 2022
@mmattel mmattel deleted the mmattel-patch-1 branch July 15, 2022 11:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dragonchaser dragonchaser Awaiting requested review from dragonchaser

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Some env content provided does not make it into the documentation