[VBLOCKS-3670] build: Update the release process to version the documentation for major versions

[luisrivas]

Pull Request Details

JIRA link(s):

• VBLOCKS-3670

Description

• Update the release process to version the documentation for major versions

Burndown

Before review

• Updated CHANGELOG.md if necessary
• Added unit tests if necessary
• Updated affected documentation
• Verified locally with npm test
• Manually sanity tested running locally
• Included screenshot as PR comment (if needed)
• Ready for review

[luisrivas]

This fixes the build step since I had this error while building:

> @twilio/video-processors@2.2.1-dev build:version
> node ./scripts/version.js

error TS2688: Cannot find type definition file for 'sinonjs__fake-timers'.
  The file is in the program because:
    Entry point for implicit type library 'sinonjs__fake-timers'


Found 1 error.

ERROR: "build:es5" exited with 2.

[charliesantos]

Instead of creating docs for every major version, can we create docs for all versions instead? It will make this simpler. Also, make the root folder as the latest docs. In other words, keep the current script as is since it's already saving the docs in the root. We just need to add a few lines in the script that creates a separate folder for that version. The directory structure would look something like the following:

[luisrivas]

Instead of creating docs for every major version, can we create docs for all versions instead? It will make this simpler. Also, make the root folder as the latest docs. In other words, keep the current script as is since it's already saving the docs in the root. We just need to add a few lines in the script that creates a separate folder for that version. The directory structure would look something like the following:

I just updated the script to create docs for all versions instead. Regarding the root folder, if I understand it correctly, any new publication would be latest and could be either v2 or v3. What do you think @charliesantos ?

[charliesantos]

Instead of creating docs for every major version, can we create docs for all versions instead? It will make this simpler. Also, make the root folder as the latest docs. In other words, keep the current script as is since it's already saving the docs in the root. We just need to add a few lines in the script that creates a separate folder for that version. The directory structure would look something like the following:

I just updated the script to create docs for all versions instead. Regarding the root folder, if I understand it correctly, any new publication would be latest and could be either v2 or v3. What do you think @charliesantos ?

This is a good point @luisrivas . I would think we don't want to overwrite the latest if it's v3, and if the new release is a v2, as an example. I think we can address that later if you want. We usually never had to backport a feature. If the customer requires something to be fixed, we usually ask them to update to the latest. Wdyt? Does this sound reasonable?

[luisrivas]

Instead of creating docs for every major version, can we create docs for all versions instead? It will make this simpler. Also, make the root folder as the latest docs. In other words, keep the current script as is since it's already saving the docs in the root. We just need to add a few lines in the script that creates a separate folder for that version. The directory structure would look something like the following:

I just updated the script to create docs for all versions instead. Regarding the root folder, if I understand it correctly, any new publication would be latest and could be either v2 or v3. What do you think @charliesantos ?

This is a good point @luisrivas . I would think we don't want to overwrite the latest if it's v3, and if the new release is a v2, as an example. I think we can address that later if you want. We usually never had to backport a feature. If the customer requires something to be fixed, we usually ask them to update to the latest. Wdyt? Does this sound reasonable?

It sounds good to me! This solution is good enough and simple that we could revisit it in the future if we need to adjust anything. Thanks for the feedback.