-
Notifications
You must be signed in to change notification settings - Fork 113
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
Reintroduce Docsy as a submodule #160
Conversation
✅ Deploy Preview for tag-env-sustainability ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
69f663c
to
36a35cd
Compare
Signed-off-by: Patrice Chalin <[email protected]>
Signed-off-by: Patrice Chalin <[email protected]>
Signed-off-by: Patrice Chalin <[email protected]>
Signed-off-by: Patrice Chalin <[email protected]>
36a35cd
to
55b17a3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Thanks.
Thanks for the review Chris. I'm unsure that the informal review policy is here, but with one approval I'm going merge and continue working on the Docsy upgrade. Comments are still welcome. |
This PR reintroduces Docsy as a submodule so that it will be easier to manage upgrades.
Details: this PR ...
website/themes/docsy
, unlinked (via a git submodule or otherwise) to any Docsy repoPreview: https://deploy-preview-160--tag-env-sustainability.netlify.app/
Context
The files under
website/themes/docsy
were a copy of google/docsy@f69a99d. But that commit is a fork commit based on google/docsy@e67775a from the official Docsy repo, with the following overrides:Regarding the diffs shown above:
themes/docsy/layouts/partials/footer.html
it is completely overridden bywebsite/layouts/partials/footer.html
and so the diff shown above is irrelevant, as is the deletion offooter-end.html
-- which isn't used bywebsite/layouts/partials/footer.html
overflow: auto in the
footer
gets set inwebsite/themes/docsy/assets/scss/main.scss
(see site-diff below), gets overridden bytag-env-sustainability/website/assets/scss/_footer.scss
Lines 2 to 4 in 38cb831
The
website/assets/scss/_footer.scss
file gets included viatag-env-sustainability/website/assets/scss/_styles_project.scss
Line 14 in 38cb831
So the SCSS diff has no visible effect.
Consequently I'm going to use the official Docsy commit google/docsy@e67775a as a basis for this repo's Docsy submodule.
No change to the rendered tag-env-sustainability site
If you build the site from this PR using the following command
npm run serve:dev
(which serves to disk), you'll see only one minor diff:Here's the diff output:
The override of
footer
'soverflow
is confirmed by examining CSS in dev tools when we examine the website prior to the changes in this PR:Related
@aliok did a great job analyzing the situation for tag-contributor-strategy, though the situation was slightly different. For details, see cncf/tag-contributor-strategy#399.
/cc @nate-double-u @caniszczyk @cjyabraham