riptano / docs-ui

The UI and theme for DataStax Docs.
https://riptano.github.io/docs-ui/
Mozilla Public License 2.0
2 stars 0 forks source link

Small adjustments in support of unified docs site #103

Closed mlr closed 4 months ago

mlr commented 4 months ago

These are some small adjustments made in support of the unified docs site build.

1. Style inline code blocks within summary titles Before (top) / After (bottom)

Screenshot 2024-02-23 at 12 19 18 PM (1)

2. Style external nav content anchors the same as xhref anchors Before (left) / After (right)

Screenshot 2024-02-23 at 12 00 35 PM (1)

3. Render navigation when single list structure is used

Prior to this change the nav tree would be unrendered / blank. We have a very large amount of doc sites that use an Antora single list structure so this change facilitates rendering those nav structures without manual edits. Over time we can move toward a top level item for every link. This is what the streaming docs site looks like with this change (prior the nav did not render).

Screenshot 2024-02-23 at 12 35 34 PM
mlr commented 4 months ago

UI bundle preview build successful! :white_check_mark: Deploying preview to GitHub Pages.

mlr commented 4 months ago

Antora site build successful! :white_check_mark: Deploying draft to GitHub Pages.

mlr commented 4 months ago

Antora site build successful! :white_check_mark: Deploying draft to GitHub Pages. Deployment successful! View draft

mlr commented 4 months ago

UI bundle preview build successful! :white_check_mark: Deploying preview to GitHub Pages. Deployment successful! View preview

eric-schneider commented 4 months ago

These are some small adjustments made in support of the unified docs site build.

1. Style inline code blocks within summary titles Before (top) / After (bottom) Screenshot 2024-02-23 at 12 19 18 PM (1)

Nice bug fix! (Sometime in the future we should do an overall design pass on all the various types of block titles.)

2. Style external nav content anchors the same as xhref anchors Before (left) / After (right) Screenshot 2024-02-23 at 12 00 35 PM (1)

I can't remember if @colegoldsmith already investigated this, but it would be nice if the automatic external link styling also applied to external links in the nav, i.e. add the external icon.

3. Render navigation when single list structure is used

Prior to this change the nav tree would be unrendered / blank. We have a very large amount of doc sites that use an Antora single list structure so this change facilitates rendering those nav structures without manual edits. Over time we can move toward a top level item for every link. This is what the streaming docs site looks like with this change (prior the nav did not render). Screenshot 2024-02-23 at 12 35 34 PM

Yeah, I think the rule should be if there are no list titles in the nav, everything should get promoted up a level.

mlr commented 4 months ago

UI bundle preview build successful! :white_check_mark: Deploying preview to GitHub Pages. Deployment successful! View preview

mlr commented 4 months ago

UI bundle preview build successful! :white_check_mark: Deploying preview to GitHub Pages. Deployment successful! View preview

mlr commented 4 months ago

Antora site build failure! :x:

mlr commented 4 months ago

I can't remember if @colegoldsmith already investigated this, but it would be nice if the automatic external link styling also applied to external links in the nav, i.e. add the external icon.

Happy to look into this in a follow up PR, the changes in this PR are going to apply for any link (external or not) in the nav that is not an xhref

mlr commented 4 months ago

Antora site build failure! :x:

{"level":"fatal","time":1708753883532,"name":"antora","err":{"type":"Error","stack":"Error\n at transformGitCloneError (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/@antora/content-aggregator/lib/aggregate-content.js:987:22)\n at /home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/@antora/content-aggregator/lib/aggregate-content.js:220:17\n at async loadRepository (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/@antora/content-aggregator/lib/aggregate-content.js:209:7)\n at async Promise.all (index 0)\n at async Promise.all (index 0)\n at async generateSite (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/@antora/site-generator/lib/generate-site.js:17:5)\n at async Command.parseAsync (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/commander/lib/command.js:935:5)\nCaused by: Error: Request timed out\n at ClientRequest. (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/simple-get/index.js:76:8)\n at ClientRequest.emit (node:events:519:28)\n at TLSSocket.emitRequestTimeout (node:_http_client:837:9)\n at Object.onceWrapper (node:events:633:28)\n at TLSSocket.emit (node:events:531:35)\n at Socket._onTimeout (node:net:589:8)\n at listOnTimeout (node:internal/timers:573:17)\n at process.processTimers (node:internal/timers:514:7)"},"msg":"Error: Request timed out (url: https://github.com/riptano/astra-vector-docs.git)"}

mlr commented 4 months ago

Antora site build successful! :white_check_mark: Deploying draft to GitHub Pages. Deployment successful! View draft