Docsy theme with latest submodule -- puts right-hand ToC in the wrong location

[mjang-cobalt]

With the latest submodule, the right-hand TOC appears in the wrong place:

With an earlier version of the Docsy submodule, it all "works fine"

The difference:

• Git commit f82dd5e works
• Git commit 6e6061b does not

The relevant PR is #554

Unknown. When I run git submodule update -f --init, it checks a later (but not the latest) commit,

43a70b21d

Workaround

Include a git checkout f82dd5e in the netlify.toml file:

[build]
publish = "public"
command = "cd themes/docsy && git submodule update -f --init && git checkout f82dd5e && cd ../..   && hugo"

[narrenfrei]

Have you tried to update the submodules recursive?
git submodule update --init --recursive

[mjang-cobalt]

Have you tried to update the submodules recursive?
`git submodule update --init --recursive

That command changes nothing in my (unfortunately private) repo.

I think I also should match the build pattern described in https://www.docsy.dev/docs/deployment/#deployment-with-netlify
Otherwise, my local build varies from what I see when building with Netlify.

Odd bit -- when I try the setup with a sample repo (based on justdocs), the pulled commit (4808e0a) is from October 2020.

[mjang-cobalt]

Also... I can replicate the issue locally on the justdocs repo, using the following steps:

1. Open a branch
2. Navigate to themes/docsy
3. Check out a problematic commit (in this case, git checkout 43a70b21d)
4. cd ../..
5. hugo mod clean
6. hugo server -D

And here's the result:

[mjang-cobalt]

I'd share the branch, but it seems I don't have access rights:

ERROR: Permission to LisaFC/justdocs.git denied to mjang-cobalt.
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

[LisaFC]

Hmm, the justdocs repo hasn't had its Docsy submodule updated in some time, I'll fix that (it's also probably not the best example for a "just docs" deployment anymore now that we have Hugo improvements as described in: https://www.docsy.dev/docs/adding-content/content/#alternative-site-structure)

The "menu accidentally appearing in the wrong place" version of the theme was from a while back and fixed pretty quickly, IIRC. If you're using the theme itself as a submodule you should be able to pull the latest Docsy theme from the repo in your local copy with git submodule update --remote

[pschrey2]

Could discussion #631 be the root cause?

[mjang-cobalt]

you should be able to pull the latest Docsy theme from the repo in your local copy with git submodule update --remote

Thanks for confirming at least part of this issue. Unfortunately, when I build to the later commit, the problem persists in Netlify.

[LisaFC]

So just to check what's happening when you're updating - the usual flow (if you're using Netlify) should be:

• Do git submodule update --remote in your local copy
• Add/commit the change:

 git add themes/
 git commit -m "Updating theme submodule" 

• push it to your repository (so your repo version is now pointing to the latest version of Docsy)
• Netlify rebuilds and publishes from that version of your repository

Is that what you've been doing?

[LisaFC]

Could discussion #631 be the root cause?

Hmm, I don't think so - the menus in the current Docsy docs work fine and they're coming from the repo head (which has the accidentally downgraded Bootstrap version).

[mjang-cobalt]

Thanks for the followup, @LisaFC . I've included the additional steps that I take, inline.

So just to check what's happening when you're updating - the usual flow (if you're using Netlify) should be:

• Do git submodule update --remote in your local copy

cd themes/docsy
git checkout f82dd5e
cd ../..
Update my netlify.toml file to check out the same submodule commit

• Add/commit the change:

 git add themes/
 git commit -m "Updating theme submodule" 

• push it to your repository (so your repo version is now pointing to the latest version of Docsy)
• Netlify rebuilds and publishes from that version of your repository

[LisaFC]

Couple of things (after which I think I might know what's going on)

• Is there a reason why you're trying to update to a specific commit rather than head? (and yes, we do need to start doing version tags)
• Is the submodule in your source repo (the one Netlify knows about) actually pointing to the version you want to use?
• You shouldn't need to update your netlify.toml to checkout the same version of the Docsy theme if the submodule in your source repo is already pointing to the correct commit, it'll just go with whatever's in the source repo - it feels like you're trying to update the submodule twice

[mjang-cobalt]

@LisaFC I'm pointing the submodule to a specific commit, as that's the latest commit that works for my build. I update my netlify.toml file to point to the same commit, otherwise the build I see from Netlify differs from the build on my local system.

it feels like you're trying to update the submodule twice

You're right. For me, it's a workaround until I either:

• Learn more about setting up submodules to find a working docsy theme build
• See a fix to this bug that works for my build