Cadence Next

[ibarrajo]

Hi Team! I'm working on a revision of the cadenceworkflow.io site.

Here is the current draft:
https://ibarrajo.github.io/cadence-docs/docs/get-started
Under the branch cadence-next

The site has included many improvements:

• Migrated vuepress to Docusaurus, which allows us to use react components and libraries like Uber Baseweb and keep frontend similar to our UI both in style and implementation. At the moment we are using Infima with Uber's color scheme.
• Automatic indexing and broken link detection
• Algolia powered search which can index resources outside of the site itself
• Dark mode
• Blog post tags
• author pages
• Announcement bar, currently set at the top with a link to our survey, improvement over this PR
• Cadence Team Page, you can edit your profile card information in the file src/components/TeamProfileCards/index.tsx
• Improved syntax highlighting, including custom support for DQL / grafana queries

A preview can be seen here: https://ibarrajo.github.io/cadence-docs/

To deploy to other gh-pages rather than the official site, it requires modification of the docusaurus.config.ts or changing a couple of environment variables

 url: 'https://ibarrajo.github.io/', // gh pages url
 baseUrl: '/cadence-docs/', 
 organizationName: 'ibarrajo', // GitHub org/user name.
 projectName: 'cadence-docs', // Repository name.

If using direnv, the following configuration can be used to change the development environment by adding a .envrc.local file to the root of the repository. This is picked up by direnv in addition to the existing .envrc file.

# Can be replaced by your GH pages url, ie. https://<userId>.github.io/
export CADENCE_DOCS_URL=https://ibarrajo.github.io/

# For GitHub pages deployment, it is often /<projectName>/ defaults to `/`
export CADENCE_DOCS_BASE_URL=/cadence-docs/

# For Github pages only, this is your Github org/user name.
export CADENCE_DOCS_ORGANIZATION=ibarrajo

To do:

• improvements on the cosmetic side of the homepage
• community documentation for contributors, bug reports, feature requests
• version the cadence documentation
• improve code block readability
• replacement for vuepress-plugin-glossary docs show the raw tooltip annotation in the meantime, like :event:events:
• environment variable overrides for production deployment via github actions
• preview deployment environment

[Assem-Uber]

Maybe too late :')
https://nextra.site/
https://npmtrends.com/docusaurus-vs-nextra