compatible: Add sync_docs.yaml #220

a-velasco · 2024-08-05T20:21:41Z

The sync_docs workflow that originally called the discourse-gatekeeper action was updated to use a simple custom script instead.

Reasoning

Greatly simplifies troubleshooting and maintenance of our documentation sync workflow.
Removes two important limitations:
1. We can give navigation groups their own landing page (e.g. A level 1 [Tutorial]() row can now have a landing page [Tutorial](/t/123) while remaining an expandable group). This functionality is part of Canonical's documentation requirements (see Diataxis docs regarding navigation).
2. We can nest items more than 1 level away from each other (e.g. A level 3 page can be followed by a level 1 page)

.github/workflows/_sync_docs_v2.md

.github/workflows/_sync_docs_v2.yaml

python/cli/data_platform_workflows_cli/download_discourse_topics.py

.github/workflows/_sync_docs_v2.yaml

python/cli/data_platform_workflows_cli/download_discourse_topics.py

.github/workflows/_sync_docs_v2.yaml

python/cli/data_platform_workflows_cli/download_discourse_topics.py

.github/workflows/_sync_docs_v2.md

.github/workflows/_sync_docs_v2.yaml

python/cli/data_platform_workflows_cli/sync_docs_v2.py

README.md

.github/workflows/_sync_docs_v2.yaml

Co-authored-by: Carl Csaposs <[email protected]>

…fixes

…-platform-workflows into download-discourse-topics

For consistent phrasing

carlcsaposs-canonical

looks good once tested!

also, fyi, the PR description will be used as the merged commit message

.github/workflows/sync_docs.md

README.md

python/cli/data_platform_workflows_cli/sync_docs.py

.github/workflows/sync_docs.yaml

python/cli/data_platform_workflows_cli/sync_docs.py

.github/workflows/sync_docs.yaml

Co-authored-by: Carl Csaposs <[email protected]>

.github/workflows/sync_docs.md

Co-authored-by: Carl Csaposs <[email protected]>

carlcsaposs-canonical

follow-up nits to #220 (comment)

.github/workflows/sync_docs.md

Co-authored-by: Carl Csaposs <[email protected]>

carlcsaposs-canonical

🚀

taurus-forever

Thank you, @a-velasco !

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [allure-pytest-collection-report](https://togithub.com/canonical/data-platform-workflows) | integration | major | `v18.0.0` -> `v20.0.1` | | [canonical/data-platform-workflows](https://togithub.com/canonical/data-platform-workflows) | action | major | `v18.0.0` -> `v20.0.1` | | [pytest-operator-cache](https://togithub.com/canonical/data-platform-workflows) | integration | major | `v18.0.0` -> `v20.0.1` | | [pytest-operator-groups](https://togithub.com/canonical/data-platform-workflows) | integration | major | `v18.0.0` -> `v20.0.1` | --- ### Release Notes <details> <summary>canonical/data-platform-workflows (allure-pytest-collection-report)</summary> ### [`v20.0.1`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v20.0.1) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v20.0.0...v20.0.1) ##### What's Changed - patch(integration_test_charm.yaml): Capture tcpdump to debug GH artifacts issue by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#229 **Full Changelog**: canonical/data-platform-workflows@v20.0.0...v20.0.1 ### [`v20.0.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v20.0.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.2.1...v20.0.0) ##### What's Changed - breaking: Remove sync_issue_to_jira.yaml by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#226 **Full Changelog**: canonical/data-platform-workflows@v19...v20.0.0 ### [`v19.2.1`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.2.1) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.2.0...v19.2.1) ##### What's Changed - patch: Switch internal Jira issue sync from workflow to bot by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#227 **Full Changelog**: canonical/data-platform-workflows@v19.2.0...v19.2.1 ### [`v19.2.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.2.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.1.0...v19.2.0) ##### What's Changed - compatible: Add sync_docs.yaml by [@a-velasco](https://togithub.com/a-velasco) in [canonical/data-platform-workflows#220 **Full Changelog**: canonical/data-platform-workflows@v19.1.0...v19.2.0 ### [`v19.1.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.1.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.0.0...v19.1.0) ##### What's Changed - compatible(integration_test_charm.yaml): Add `jhack tail` to logs by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#225 **Full Changelog**: canonical/data-platform-workflows@v19.0.0...v19.1.0 ### [`v19.0.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.0.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v18.0.1...v19.0.0) #### What's Changed - breaking(integration_test_charm.yaml): Remove `jhack tail` logs by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#224 **Full Changelog**: canonical/data-platform-workflows@v18...v19.0.0 ### [`v18.0.1`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v18.0.1) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v18.0.0...v18.0.1) #### What's Changed - patch(release_\*.yaml): Fix auto-generated release notes by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#222 **Full Changelog**: canonical/data-platform-workflows@v18.0.0...v18.0.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 1am and before 3am every weekday" in timezone Etc/UTC, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/canonical/mysql-router-k8s-operator).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [canonical/data-platform-workflows](https://togithub.com/canonical/data-platform-workflows) | action | major | `v18.0.0` -> `v21.0.0` | | [pytest-github-secrets](https://togithub.com/canonical/data-platform-workflows) | integration | major | `v18.0.0` -> `v21.0.0` | | [pytest-operator-cache](https://togithub.com/canonical/data-platform-workflows) | integration | major | `v18.0.0` -> `v21.0.0` | | [pytest-operator-groups](https://togithub.com/canonical/data-platform-workflows) | integration | major | `v18.0.0` -> `v21.0.0` | --- ### Release Notes <details> <summary>canonical/data-platform-workflows (canonical/data-platform-workflows)</summary> ### [`v21.0.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v21.0.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v20.0.3...v21.0.0) ##### What's Changed - breaking(integration_test_charm.yaml): Only run juju 3.6 tests on `schedule` by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#232 **Full Changelog**: canonical/data-platform-workflows@v20...v21.0.0 ### [`v20.0.3`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v20.0.3) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v20.0.2...v20.0.3) ##### What's Changed - patch(integration_test_charm.yaml): Add missing timeout-minutes by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#231 **Full Changelog**: canonical/data-platform-workflows@v20.0.2...v20.0.3 ### [`v20.0.2`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v20.0.2) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v20.0.1...v20.0.2) ##### What's Changed - patch(integration_test_charm.yaml): Fix tcpdump debug capture by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#230 **Full Changelog**: canonical/data-platform-workflows@v20.0.1...v20.0.2 ### [`v20.0.1`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v20.0.1) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v20.0.0...v20.0.1) ##### What's Changed - patch(integration_test_charm.yaml): Capture tcpdump to debug GH artifacts issue by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#229 **Full Changelog**: canonical/data-platform-workflows@v20.0.0...v20.0.1 ### [`v20.0.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v20.0.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.2.1...v20.0.0) #### What's Changed - breaking: Remove sync_issue_to_jira.yaml by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#226 **Full Changelog**: canonical/data-platform-workflows@v19...v20.0.0 ### [`v19.2.1`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.2.1) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.2.0...v19.2.1) #### What's Changed - patch: Switch internal Jira issue sync from workflow to bot by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#227 **Full Changelog**: canonical/data-platform-workflows@v19.2.0...v19.2.1 ### [`v19.2.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.2.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.1.0...v19.2.0) #### What's Changed - compatible: Add sync_docs.yaml by [@a-velasco](https://togithub.com/a-velasco) in [canonical/data-platform-workflows#220 **Full Changelog**: canonical/data-platform-workflows@v19.1.0...v19.2.0 ### [`v19.1.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.1.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v19.0.0...v19.1.0) ##### What's Changed - compatible(integration_test_charm.yaml): Add `jhack tail` to logs by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#225 **Full Changelog**: canonical/data-platform-workflows@v19.0.0...v19.1.0 ### [`v19.0.0`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v19.0.0) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v18.0.1...v19.0.0) #### What's Changed - breaking(integration_test_charm.yaml): Remove `jhack tail` logs by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#224 **Full Changelog**: canonical/data-platform-workflows@v18...v19.0.0 ### [`v18.0.1`](https://togithub.com/canonical/data-platform-workflows/releases/tag/v18.0.1) [Compare Source](https://togithub.com/canonical/data-platform-workflows/compare/v18.0.0...v18.0.1) #### What's Changed - patch(release_\*.yaml): Fix auto-generated release notes by [@carlcsaposs-canonical](https://togithub.com/carlcsaposs-canonical) in [canonical/data-platform-workflows#222 **Full Changelog**: canonical/data-platform-workflows@v18.0.0...v18.0.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 1am and before 3am every weekday" in timezone Etc/UTC, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View the [repository job log](https://developer.mend.io/github/canonical/mysql-router-operator).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

This PR changes the `sync_docs.yaml` workflow to the [new version with a different backend](canonical/data-platform-workflows#220 (comment)).

A [new `sync_docs.yaml` workflow](canonical/data-platform-workflows#220) was released in data-platform-workflows `v19.2.0`. It overwrites the old experimental `_sync_docs.yaml` workflow and releases it to the public interface. This PR: * Corrects the filename to match the new syntax without the experimental `_` prefix. * Removes the now unnecessary Discourse API credentials * Adds automatic reviewers

First commit

fd58087

carlcsaposs-canonical reviewed Aug 6, 2024

View reviewed changes

python/cli/data_platform_workflows_cli/download_discourse_topics.py Outdated Show resolved Hide resolved

a-velasco added 3 commits August 7, 2024 19:51

Misc PR review fixes

8821fbc

Removing run schedule since there are no longer API constraints

71f818c

Using GITHUB_TOKEN instead of PA TOKEN

330982e

a-velasco marked this pull request as ready for review August 7, 2024 18:47

carlcsaposs-canonical reviewed Aug 8, 2024

View reviewed changes

a-velasco and others added 13 commits August 8, 2024 11:22

Update .github/workflows/_sync_docs_v2.yaml

a2e0463

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/_sync_docs_v2.yaml

6b8e227

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/_sync_docs_v2.yaml

0561751

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/_sync_docs_v2.md

ac42f67

Co-authored-by: Carl Csaposs <[email protected]>

Update python/cli/data_platform_workflows_cli/sync_docs_v2.py

ee2866b

Co-authored-by: Carl Csaposs <[email protected]>

Update python/cli/data_platform_workflows_cli/sync_docs_v2.py

c92536f

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/_sync_docs_v2.yaml

3c43657

Co-authored-by: Carl Csaposs <[email protected]>

Small edits

64f0a61

Replaced original sync_docs with v2 and removed experimental file pre…

17e4327

…fixes

Merge branch 'download-discourse-topics' of github.com:canonical/data…

39cd6c0

…-platform-workflows into download-discourse-topics

Update sync_docs.md

bd3c59c

Update README.md

0d196b5

Update sync_docs.yaml

908c137

For consistent phrasing

carlcsaposs-canonical reviewed Aug 9, 2024

View reviewed changes

carlcsaposs-canonical changed the title ~~patch: Add _sync_docs_v2.yaml~~ compatible: Add sync_docs.yaml Aug 9, 2024

a-velasco and others added 7 commits August 9, 2024 11:58

Update .github/workflows/sync_docs.md

67f50a4

Co-authored-by: Carl Csaposs <[email protected]>

Update python/cli/data_platform_workflows_cli/sync_docs.py

ee6932f

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/sync_docs.yaml

5731b97

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/sync_docs.yaml

9f46bd4

Co-authored-by: Carl Csaposs <[email protected]>

Update README.md

d645e02

Update python/cli/data_platform_workflows_cli/sync_docs.py

ca1164a

Co-authored-by: Carl Csaposs <[email protected]>

Formatted with isort

6460585

carlcsaposs-canonical approved these changes Aug 13, 2024

View reviewed changes

.github/workflows/sync_docs.md Outdated Show resolved Hide resolved

.github/workflows/sync_docs.md Outdated Show resolved Hide resolved

.github/workflows/sync_docs.md Outdated Show resolved Hide resolved

a-velasco and others added 3 commits August 13, 2024 09:36

Update .github/workflows/sync_docs.md

982fce9

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/sync_docs.md

f121d08

Co-authored-by: Carl Csaposs <[email protected]>

Update sync_docs.md

d1b71fb

carlcsaposs-canonical reviewed Aug 13, 2024

View reviewed changes

.github/workflows/sync_docs.md Outdated Show resolved Hide resolved

.github/workflows/sync_docs.md Outdated Show resolved Hide resolved

.github/workflows/sync_docs.md Outdated Show resolved Hide resolved

a-velasco and others added 5 commits August 13, 2024 10:04

Update .github/workflows/sync_docs.md

46b5238

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/sync_docs.md

d33bea5

Co-authored-by: Carl Csaposs <[email protected]>

Update .github/workflows/sync_docs.md

dccdd38

Co-authored-by: Carl Csaposs <[email protected]>

Update sync_docs.md

d048543

Update sync_docs.md

e885889

carlcsaposs-canonical approved these changes Aug 13, 2024

View reviewed changes

Fixed bad indentation in yaml template

5a80297

taurus-forever approved these changes Aug 16, 2024

View reviewed changes

a-velasco merged commit 4c77e41 into main Aug 16, 2024
1 check passed

a-velasco deleted the download-discourse-topics branch August 16, 2024 10:23

a-velasco mentioned this pull request Aug 19, 2024

Update sync_docs.yaml to new version canonical/pgbouncer-k8s-operator#381

Merged

a-velasco added a commit to canonical/mysql-router-k8s-operator that referenced this pull request Aug 27, 2024

Update sync_docs.yaml (#300)

27a5975

This PR changes the `sync_docs.yaml` workflow to the [new version with a different backend](canonical/data-platform-workflows#220 (comment)).

a-velasco mentioned this pull request Sep 3, 2024

Update sync_docs.yaml canonical/mysql-router-operator#175

Merged

This was referenced Sep 16, 2024

Create sync_docs.yaml canonical/mongodb-k8s-operator#334

Open

Create sync_docs.yaml canonical/mongodb-operator#487

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

compatible: Add sync_docs.yaml #220

compatible: Add sync_docs.yaml #220

a-velasco commented Aug 5, 2024 •

edited by carlcsaposs-canonical

Loading

carlcsaposs-canonical left a comment

carlcsaposs-canonical left a comment

carlcsaposs-canonical left a comment

taurus-forever left a comment

compatible: Add sync_docs.yaml #220

compatible: Add sync_docs.yaml #220

Conversation

a-velasco commented Aug 5, 2024 • edited by carlcsaposs-canonical Loading

Reasoning

carlcsaposs-canonical left a comment

Choose a reason for hiding this comment

carlcsaposs-canonical left a comment

Choose a reason for hiding this comment

carlcsaposs-canonical left a comment

Choose a reason for hiding this comment

taurus-forever left a comment

Choose a reason for hiding this comment

a-velasco commented Aug 5, 2024 •

edited by carlcsaposs-canonical

Loading