Skip to content

Add workflow for importing documentation from everest-doc by version#5

Draft
solovevayaroslavna wants to merge 2 commits intoopeneverest:mainfrom
solovevayaroslavna:feature/documentation-exporting
Draft

Add workflow for importing documentation from everest-doc by version#5
solovevayaroslavna wants to merge 2 commits intoopeneverest:mainfrom
solovevayaroslavna:feature/documentation-exporting

Conversation

@solovevayaroslavna
Copy link
Copy Markdown
Contributor

this workflow waits https://github.com/percona/everest-doc trigger for automatically adding the new release tag documenation build to a web page

@solovevayaroslavna solovevayaroslavna marked this pull request as draft December 11, 2025 05:44
…rence for checkout and push in tag-release workflow

- name: Run import script
run: |
bash hack/import_docs.sh ${{ inputs.version }}
Copy link
Copy Markdown
Contributor

@chilagrow chilagrow Dec 11, 2025

Choose a reason for hiding this comment

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

I'm not sure if it's a good idea to add automated workflow on top of a hack. Just a question, why is importing document a hack? 🤔

Also I often make sure that what goes into main branch is reviewed by some human 🤔. What do you think?

Copy link
Copy Markdown
Contributor Author

@solovevayaroslavna solovevayaroslavna Dec 11, 2025

Choose a reason for hiding this comment

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

We can change the script so that it immediately prepares the PR with the changes, so that only a couple of buttons remain to be pressed, what do you think about this?

To be honest hack - it's just a name. It's not something illegal or forbidden.

I just don't think it's common practice to import static files from another repository
Maybe we'll find a more beautiful way later... like... to have a subrepo of documentation and catch the build another way.

Copy link
Copy Markdown
Contributor

@chilagrow chilagrow Dec 12, 2025

Choose a reason for hiding this comment

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

Thanks for the explanation! I understand your concern about importing static files from another repo is not standard 😄. What is standard for using content from another repository is git submodule, which is as you say, subrepo. Let's keep it as an option for future.

I like the idea about preparing PR! Then we can see it with our eyes before we merge 🤗

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

So what do we do here? :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@spron-in I will correct the script so that it creates a new PR in this repository if a new tag with a new version of release-notes appears in the everest-doc (but a little later, closer to the moment when we want to release a new tag for open-everest)

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.

3 participants