You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current functionality of this library takes care of versioning docs assets (i.e. docs/assets/ directory) since that's the convention from Docusaurus V1. But, there are other "static assets" that are currently not being versioned. In the source repo, those are typically stored in website/static/ directory. For example: we want to serve some portions of statically generated site along side docusaurus (i.e. javadocs generated from a project's source code). Only way to effectively serve those generated html files is to save them as static assets (i.e. website/static/javadocs/ directory). But, we need a way to version those when regular markdown documents are versioned.
Proposal
Add the ability to version static assets when markdown documents are being versioned. When the CLI of this library is invoked, the user should be able to provide additional parameter to specify which directory within website/static/ dir should be versioned. This should be optional parameter. As part of the overall versioning process, additional tasks will be performed if static assets needs to be versioned:
If versioning is being done for the first time:
Copy the given static asset directory as a versioned asset. For example: copy website/static/javadocs dir to website/static/javadocs/<version-value> dir
Clone website/static/javadocs/<version-value> to website/static/javadocs/next dir
Update markdown documents containing links to those static assets:
Update markdown files in docs/ directory with relative links to those static assets to point to "next version" (i.e. change ../javadocs/<remaining-file-path> to ../../javadocs/next/<remaining-file-path>
Update markdown files in newly created versions in website/versioned_docs/version-<version-value>/ directory with relative links to those static assets to point to "versioned files" (i.e. change ../javadocs/<remaining-file-path> to ../javadocs/<version-value>/<remaining-file-path>
If versioning for subsequent times (i.e. not a first version):
Copy the given static asset directory as a versioned asset. For example: copy website/static/javadocs/next dir to website/static/javadocs/<version-value> dir
Update markdown documents containing links to those static assets:
Update markdown files in newly created versions in website/versioned_docs/version-<version-value>/ directory with relative links to those static assets to point to "versioned files" (i.e. change ../javadocs/<remaining-file-path> to ../javadocs/<version-value>/<remaining-file-path>
The text was updated successfully, but these errors were encountered:
The current functionality of this library takes care of versioning docs assets (i.e.
docs/assets/
directory) since that's the convention from Docusaurus V1. But, there are other "static assets" that are currently not being versioned. In the source repo, those are typically stored inwebsite/static/
directory. For example: we want to serve some portions of statically generated site along side docusaurus (i.e. javadocs generated from a project's source code). Only way to effectively serve those generated html files is to save them as static assets (i.e.website/static/javadocs/
directory). But, we need a way to version those when regular markdown documents are versioned.Proposal
Add the ability to version static assets when markdown documents are being versioned. When the CLI of this library is invoked, the user should be able to provide additional parameter to specify which directory within
website/static/
dir should be versioned. This should be optional parameter. As part of the overall versioning process, additional tasks will be performed if static assets needs to be versioned:website/static/javadocs
dir towebsite/static/javadocs/<version-value>
dirwebsite/static/javadocs/<version-value>
towebsite/static/javadocs/next
dirdocs/
directory with relative links to those static assets to point to "next version" (i.e. change../javadocs/<remaining-file-path>
to../../javadocs/next/<remaining-file-path>
website/versioned_docs/version-<version-value>/
directory with relative links to those static assets to point to "versioned files" (i.e. change../javadocs/<remaining-file-path>
to../javadocs/<version-value>/<remaining-file-path>
website/static/javadocs/next
dir towebsite/static/javadocs/<version-value>
dirwebsite/versioned_docs/version-<version-value>/
directory with relative links to those static assets to point to "versioned files" (i.e. change../javadocs/<remaining-file-path>
to../javadocs/<version-value>/<remaining-file-path>
The text was updated successfully, but these errors were encountered: