search

google / docsy

A set of Hugo doc templates for launching open source content.
https://docsy.dev
Apache License 2.0
2.57k stars 893 forks source link

Updating Docsy moves navbar to the left (wrong) side #590

Closed mhansen closed 3 years ago

mhansen commented 3 years ago

Hi there, I just updated Graphviz to the latest Docsy with git submodule update --remote, now the table of contents is on the wrong side of the screen:

image

I suspect this is related to #554 merged 2 days ago, because that commit changed the navbar HTML layout from a <div> tag to an <aside> tag: https://github.com/google/docsy/pull/554/files#diff-4a7bcb5855bcc928f61527aba2cb16f957266b13ab51553e46016c82ac8c4dd2R16. But I haven't looked into it further than that yet.

mhansen commented 3 years ago

If you'd like to reproduce, git clone https://gitlab.com/graphviz/graphviz.gitlab.io and run git submodule update --remote then hugo serve

mhansen commented 3 years ago

I just confirmed that #554 is the cause: I checked out f82dd5efa0eb5a03086498686f9e60f7bd2bb5f3 (immediately before #554 was merged) and the navbar is on the correct side.

mhansen commented 3 years ago

@narrenfrei FYI -- perhaps this has the same cause as the test data getting into docsy.dev?

LisaFC commented 3 years ago

Oh yeah, that shouldn't do that - let me take a look. I don't think it's anything to do with the test data, that was just data that got merged in in error.

LisaFC commented 3 years ago

Though it is very weird, as if I look at the deploy preview for #554 (https://deploy-preview-554--docsydocs.netlify.app/docs/) the table of contents is in the right place, so I'm not sure why it's shifted left for you. Can you tell me what browser you're using?

We'll try and get the test data removed ASAP as well.

mhansen commented 3 years ago

Yeah, maybe it’s something about my layout. I’m using macOS Google Chrome.

On Mon, 14 Jun 2021 at 19:55, LisaFC @.***> wrote:

Though it is very weird, as if I look at the deploy preview for #554 https://github.com/google/docsy/pull/554 ( https://deploy-preview-554--docsydocs.netlify.app/docs/) the table of contents is in the right place, so I'm not sure why it's shifted left for you. Can you tell me what browser you're using?

We'll try and get the test data removed ASAP as well.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/google/docsy/issues/590#issuecomment-860556630, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZYOP4F26WWVWG2YJ5V3LTSXGXHANCNFSM46ULWQLA .

narrenfrei commented 3 years ago

Maybe it's browser specific. But I have to ask: do you have any project specific Stylesheets?

mhansen commented 3 years ago

The only extra css we add is prism.css for syntax highlighting.

On Mon, 14 Jun 2021 at 19:59, Franz Steininger @.***> wrote:

Maybe it's browser specific. But I have to ask: do you have any project specific Stylesheets?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/google/docsy/issues/590#issuecomment-860559673, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZYOK74IZIT6ISPGOJVA3TSXHJBANCNFSM46ULWQLA .

narrenfrei commented 3 years ago

@mhansen Have you tried to update all sub modules as described in https://www.docsy.dev/docs/getting-started/#using-the-command-line by git submodule update --init --recursive?

Because after running your commands above ...

git clone https://gitlab.com/graphviz/graphviz.gitlab.io
git submodule update --remote
hugo server

... I've got some error message. But after running git submodule update --init --recursive Hugo could build the site and the TOC was shown on the right position.

mhansen commented 3 years ago

I'm able to build the site. Is the error message you get

"WARNING: calling IsSet with unsupported type "invalid" () will always return false."?

I think git submodule update --init --recursive undoes the git submodule update --remote, reverting back to the previously-commited version of docsy.

On Tue, 15 Jun 2021 at 06:57, Franz Steininger @.***> wrote:

@mhansen https://github.com/mhansen Have you tried to update all sub modules as described in https://www.docsy.dev/docs/getting-started/#using-the-command-line by git submodule update --init --recursive?

Because after running your commands above ...

git clone https://gitlab.com/graphviz/graphviz.gitlab.io git submodule update --remote hugo server

... I've got some error message. But after running git submodule update --init --recursive Hugo could build the site and the TOC was shown on the right position.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/google/docsy/issues/590#issuecomment-860990251, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZYOLTR4TZMHETR4EQK2DTSZULXANCNFSM46ULWQLA .

mhansen commented 3 years ago

Try this, I think I skipped a step:

git clone https://gitlab.com/graphviz/graphviz.gitlab.io git submodule update --init --recursive git submodule update --remote hugo server

On Tue, 15 Jun 2021 at 08:58, Mark Hansen @.***> wrote:

I'm able to build the site. Is the error message you get

"WARNING: calling IsSet with unsupported type "invalid" () will always return false."?

I think git submodule update --init --recursive undoes the git submodule update --remote, reverting back to the previously-commited version of docsy.

On Tue, 15 Jun 2021 at 06:57, Franz Steininger @.***> wrote:

@mhansen https://github.com/mhansen Have you tried to update all sub modules as described in https://www.docsy.dev/docs/getting-started/#using-the-command-line by git submodule update --init --recursive?

Because after running your commands above ...

git clone https://gitlab.com/graphviz/graphviz.gitlab.io git submodule update --remote hugo server

... I've got some error message. But after running git submodule update --init --recursive Hugo could build the site and the TOC was shown on the right position.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/google/docsy/issues/590#issuecomment-860990251, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZYOLTR4TZMHETR4EQK2DTSZULXANCNFSM46ULWQLA .

narrenfrei commented 3 years ago

After this steps I get also the right positioned TOC. Tested on MAC with Safari, Chrome and Firefox

LisaFC commented 3 years ago

Excellent! Can I close the issue?

mhansen commented 3 years ago

Ah, sorry for the hassle. I just reran my own repro steps in a fresh git repo and couldn't reproduce. Sorry for wasting your time; I'll close this for now and update if I figure out how I screwed up my git repository. Probably ran some bad submodule command.

mhansen commented 3 years ago

By the way, on the fresh repo I still see this error WARNING: calling IsSet with unsupported type "invalid" (<nil>) will always return false., do you see that too? It seems new in the latest merge request (#554) but perhaps again I messed up my git repo.

mhansen commented 3 years ago

For the archives: I think I just had my git submodules out of sync -- perhaps I had a different bootstrap submodule than a docsy submodule. Running a few submodule update commands fixed it. Sorry again for the trouble!

On Tue, 15 Jun 2021 at 19:13, LisaFC @.***> wrote:

Excellent! Can I close the issue?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/google/docsy/issues/590#issuecomment-861331574, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAZYOOQO7M6YJBDZ6UT2EDTS4KSHANCNFSM46ULWQLA .