Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small adjustments in support of unified docs site #103

Merged
merged 3 commits into from
Feb 24, 2024
Merged

Small adjustments in support of unified docs site #103

merged 3 commits into from
Feb 24, 2024

Conversation

mlr
Copy link
Contributor

@mlr mlr commented Feb 23, 2024

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
Copy link
Contributor Author

mlr commented Feb 23, 2024

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.

@mlr
Copy link
Contributor Author

mlr commented Feb 23, 2024

Antora site build successful! ✅
Deploying draft to GitHub Pages.

@mlr
Copy link
Contributor Author

mlr commented Feb 23, 2024

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

@mlr
Copy link
Contributor Author

mlr commented Feb 23, 2024

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

@eric-schneider
Copy link
Contributor

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
Copy link
Contributor Author

mlr commented Feb 24, 2024

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

@mlr mlr closed this Feb 24, 2024
@mlr mlr reopened this Feb 24, 2024
@mlr
Copy link
Contributor Author

mlr commented Feb 24, 2024

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

@mlr
Copy link
Contributor Author

mlr commented Feb 24, 2024

Antora site build failure! ❌

@mlr
Copy link
Contributor Author

mlr commented Feb 24, 2024

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

Copy link
Collaborator

@colegoldsmith colegoldsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@mlr
Copy link
Contributor Author

mlr commented Feb 24, 2024

Antora site build failure! ❌

{"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
Copy link
Contributor Author

mlr commented Feb 24, 2024

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

@mlr mlr merged commit b75c032 into main Feb 24, 2024
3 of 4 checks passed
@mlr mlr deleted the unified branch February 24, 2024 06:09
@mlr mlr mentioned this pull request Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants