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.

Sign up for GitHub

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

Jump to bottom

Upgrade grpc.io-docsy to match docsy 0.4.0 #1027

Merged
merged 3 commits into from
Aug 12, 2022
Merged

Upgrade grpc.io-docsy to match docsy 0.4.0 #1027

merged 3 commits into from
Aug 12, 2022

Conversation

chalin
Copy link
Collaborator

@chalin chalin commented Aug 11, 2022 •
edited
Loading

  • With this PR, there are no more recursive git submodules.
  • This PR allows us to subsequently upgrade Hugo beyond 0.99.1
  • To view the diff between the grpc.io branch and the main Docsy branch use the following URL (not bad, only 10 files differ): google/docsy@v0.4.0...grpc:grpc.io-docsy:grpc.io-upto-doccsy-0.4.0
  • Generated site file diffs are mainly due to aria-disabled being added to the last of the breadcrumbs: 
    $ (cd public && git diff -bw --ignore-blank-lines -I "<html (lang|itemscope)" -I "fab fa-github|fas fa-tasks" -I "td-(docs|section)-nav" -- . ':(exclude)*.map' ':(exclude)*.css' ':(exclude)*.js') | grep  -E '^- |^\+ ' | grep -v '<a href="https://grpc.io/docs/' | grep -v aria-diabled
$
$ (cd public && git diff -bw --ignore-blank-lines -I "<html (lang|itemscope)" -I "fab fa-github|fas fa-tasks" -I "td-(docs|section)-nav" -- . ':(exclude)*.map' ':(exclude)*.css' ':(exclude)*.js') | grep -E '^- |^\+ '
-    <a href="https://grpc.io/docs/guides/auth/">Authentication</a>
+    <a href="https://grpc.io/docs/guides/auth/" aria-disabled="true" class="btn-link disabled">Authentication</a>
-    <a href="https://grpc.io/docs/guides/benchmarking/">Benchmarking</a>
+    <a href="https://grpc.io/docs/guides/benchmarking/" aria-disabled="true" class="btn-link disabled">Benchmarking</a>
-    <a href="https://grpc.io/docs/guides/error/">Error handling</a>
+    <a href="https://grpc.io/docs/guides/error/" aria-disabled="true" class="btn-link disabled">Error handling</a>
-    <a href="https://grpc.io/docs/guides/">Guides</a>
+    <a href="https://grpc.io/docs/guides/" aria-disabled="true" class="btn-link disabled">Guides</a>
-    <a href="https://grpc.io/docs/guides/performance/">Performance Best Practices</a>
+    <a href="https://grpc.io/docs/guides/performance/" aria-disabled="true" class="btn-link disabled">Performance Best Practices</a>
...

Other changes:

  • Page-meta link Create documentation issue now uses the same icon as Create project issue
  • Slight adjustment in font sizes due to RFS (Responsive font size) implementation twbs/bootstrap#23816. For example, compare the page footer text before and after. I've ensured that, e.g., the footer design still works on mobile.

/cc @nate-double-u

@chalin
Upgrade grpc.io-docsy to match docsy 0.4.0
2454ddb 
Notice that there are no more recursive git submodules.
@chalin
Copy link
Collaborator Author

chalin commented Aug 11, 2022

Example of the newly disabled breadcrumbs (last breadcrumb):

image

@chalin
Copy link
Collaborator Author

chalin commented Aug 12, 2022

This update is affected by the following issue:

So let's hold this change until I get to think about it a bit more. (I'll probably just override the @imported style file that is overriding the base Bootstrap card files.)

@chalin chalin marked this pull request as draft August 12, 2022 00:11
@chalin chalin marked this pull request as ready for review August 12, 2022 12:58
@chalin
Copy link
Collaborator Author

chalin commented Aug 12, 2022

I've applied a workaround to the Docsy card-shortcode style leakage.

@chalin chalin mentioned this pull request Aug 12, 2022
Open
@chalin chalin merged commit 15f1678 into grpc:main Aug 12, 2022
@chalin chalin deleted the chalin-im-upgrade-to-grpc.io-docsy-040-2022-08-11 branch August 12, 2022 13:55
dfawley pushed a commit to dfawley/grpc.io that referenced this pull request Sep 10, 2024
@chalin @dfawley
Upgrade grpc.io-docsy to match docsy 0.4.0 (grpc#1027)
4b79fe0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
infrastructure
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@chalin