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

Fix automation between TS SDK and Docs Hub #3444

Open
arboleya opened this issue Dec 3, 2024 · 2 comments
Open

Fix automation between TS SDK and Docs Hub #3444

arboleya opened this issue Dec 3, 2024 · 2 comments
Assignees
Labels
docs Requests pertinent to documentation

Comments

@arboleya
Copy link
Member

arboleya commented Dec 3, 2024

When any PR is merged to master, CI triggers a workflow on the Docs Hub repo, which creates another PR for updating such docs. This PR, when approved, triggers a deploy routine that goes, updates, and redeploys the docs.

The aim here is to remove the manual approval step so that the docs are automatically updated with the latest releases every time a new PR goes to master. Check the flowchart at the end.

Given our previous interactions with the docs, we should lead this effort with DevRel.

flowchart TB;
  SDK(SDK) --> PR
  SDK --> Release
  PR{Merged PR} --> |updates| Nightly(Nightly Docs)
  Release{New Release} --> |updates| Stable(Stable Docs)
Loading
@arboleya arboleya added the docs Requests pertinent to documentation label Dec 3, 2024
@arboleya
Copy link
Member Author

arboleya commented Dec 3, 2024

cc @rishabhkeshan @calldelegation

Copy link

linear bot commented Dec 19, 2024

Marking this as blocked since the devrel team is doing a rewrite of the docs-hub, so waiting on that until that happens.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

No branches or pull requests

2 participants