hyperledger / identus-docs

Documentation website for the Identus Platform
Apache License 2.0
7 stars 1 forks source link

Multi DOC versions for Typescript SDK #103

Open elribonazo opened 4 weeks ago

elribonazo commented 4 weeks ago

Multi doc portal

The main goal of this ticket, discussion to talk about the different approaches that we have to get multiple versions of the typescript SDK deployed each time the SDK goes out.

We need some bash scripting at least:

Knowing the tag that we are going to release, generate the documentation in the typescript repository and commit the files, then Call the Specific action in docs portal to deploy to production. This ci task starts a branch from main, pulls the TS changes, creates a Pull request + asks for Review.

There's several approaches, who will initiate the commits, the TS repository, the cloud agent? Things to keep in mind: Docs repo should store all versions TS Repo should store latest Docs repo will be in charge of programmatically creating or changing the sidebar. During the PR, the devs can still make changes or adjustments because the CI task will just facilitate but not commit or merge anything for us.

elribonazo commented 4 weeks ago

@amagyar-iohk @todorkoleviohk Let me know what u think :)

I think we could get that done pretty fast!!