Skip to content

Add cockpit docs#435

Closed
nightkr wants to merge 5 commits into
mainfrom
feature/cockpit
Closed

Add cockpit docs#435
nightkr wants to merge 5 commits into
mainfrom
feature/cockpit

Conversation

@nightkr
Copy link
Copy Markdown
Contributor

@nightkr nightkr commented Aug 4, 2023

I've probably screwed this up pretty bad.. the header bar behaves very strangely for me locally compared to on docs.stackable.tech.

Ideally this would also only show up for nightly docs (currently), not sure what the ideal way to do that is.

@nightkr nightkr requested a review from a team August 4, 2023 14:16
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 4, 2023

Deploy Preview for stackable-docs failed.

Name Link
🔨 Latest commit 3e249f3
🔍 Latest deploy log https://app.netlify.com/sites/stackable-docs/deploys/64d11032916e590008c5d4f4

@fhennig
Copy link
Copy Markdown
Contributor

fhennig commented Aug 7, 2023

The changes look fine to me in the files, I can take a look at it more why it might look wonky if you want to!

The navbar is part of the template, and so far the template is always the same for all versions. I don't think there is a way to make this only show up in certain versions.

Edit: Actually the preview also looks fine to me! What browser are you using?

@nightkr
Copy link
Copy Markdown
Contributor Author

nightkr commented Aug 7, 2023

Oh, I think I see the problem. The links go to the old-style paths, which redirect immediately on Netlify, but give an interstitial for local builds.

@nightkr
Copy link
Copy Markdown
Contributor Author

nightkr commented Aug 7, 2023

The navbar is part of the template, and so far the template is always the same for all versions. I don't think there is a way to make this only show up in certain versions.

How do we handle this for new operators then? Just letting them 404 until the new release is out doesn't seem ideal...

@nightkr
Copy link
Copy Markdown
Contributor Author

nightkr commented Aug 7, 2023

Fixed the links in dfb1fe7, still unsure about how to handle the cockpit navbar entry. Make remove it from the navbar again and just let it live in the nav hierarchy?

@fhennig
Copy link
Copy Markdown
Contributor

fhennig commented Aug 8, 2023

Okay, I noticed a couple of things. The two playbook files still reference different branches (In one of them it still says FIXME).

I think the antora.yml should not be part of home but should be more like the one for stackablectl. We have the home component for all the operators and the main docs, which are all versioned together. But the stackablectl docs are not versioned, and are in a separate component. I think the cockpit docs would also be unversioned, right? That should also fix the 404 issue I believe.

So maybe something like this:

name: stackable-cockpit
version: nightly (or stable or whatever)
title: Stackable Cockpit
nav:
  - ...

And then the path would also be /stackable-cockpit/stable/index.html. It will be stable regardless which version you put there, if there is only one version, antora will always take that one as the stable one.

@Techassi Techassi closed this Sep 12, 2023
@lfrancke lfrancke deleted the feature/cockpit branch July 2, 2025 10:52
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.

3 participants