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

Update and simplify docs #63

Merged
merged 7 commits into from
Sep 12, 2023
Merged

Update and simplify docs #63

merged 7 commits into from
Sep 12, 2023

Conversation

joseph-henry
Copy link
Contributor

No description provided.

@joseph-henry joseph-henry mentioned this pull request Aug 17, 2023
Closed
@joseph-henry
Copy link
Contributor Author

Change is tiny, and more reworking is coming but I'd like to know if this update works for everyone else.

@glimberg
Copy link
Contributor

It's failing in Drone right now

@glimberg
Copy link
Contributor

https://drone.ci.lab/zerotier/docs/162/1/2

@glimberg
Copy link
Contributor

unfortunately, autogenerating the sidebar is going to kill links to the external libzt docs

@joseph-henry
Copy link
Contributor Author

To summarize latest work:

  • This PR doesn't break any URLs or introduce any significant content changes
  • the openAPI plugin doesn't seem to play well with autogenerated sidebars so we still define that manually (but only that)
  • Some items that were commented out of the sidebars.js file were moved to ./draft
  • Some items like ZeroNSD and API Docs have slightly different category ordering/structure but the URLs remain the same (I'm proposing more drastic changes in the next PR anyway so I wouldn't sweat this)

Ideally from the content consumer's perspective not much has changed. If we're all still ok with what's here I can merge this and get the next content PR ready.

@joseph-henry
Copy link
Contributor Author

joseph-henry commented Sep 11, 2023 •
edited
Loading

@joylarkin I'm going to look into implementing the category indices you mentioned
@glimberg @laduke See anything wonky here? It works on my machine and mostly looks the same as current.
@rcoder The next PR is going to be a content re-org that we can bring everyone into to discuss

@joseph-henry joseph-henry changed the title Update docusaurus to 2.4.1, add mermaid, fix deprecation issues Update and simplify docs Sep 11, 2023
@laduke
Copy link
Contributor

laduke commented Sep 11, 2023

going to get this up and running locally asap

@joseph-henry
Copy link
Contributor Author

There was a theme adjustment to get around some deprecation errors when upgrading so you might notice some font sizes a little different but I think they're very minor.

@laduke
Copy link
Contributor

laduke commented Sep 11, 2023

i see a couple funky articles out of their categories

Screenshot 2023-09-11 at 3 39 05 PM

I just did yarn install; yarn start

@laduke
Copy link
Contributor

laduke commented Sep 11, 2023 •
edited
Loading

haha nevermind
those are uncommitted markdown files in my repo that i forgot about

it's auto-finding new articles 👍

@laduke
Make the "introduction" article go first
184a86a 
The self-hosting category was looking like this:
Self-Host
  Network controller
  Introduction

Putting sidebar_position: 1 was the first solution I
found.
@laduke
Copy link
Contributor

laduke commented Sep 11, 2023

some of the categories are in a different order but we can futz with that later probably IMO

@glimberg
Copy link
Contributor

looking good to me so far

@joseph-henry
Copy link
Contributor Author

some of the categories are in a different order but we can futz with that later probably IMO

Yes they are but I'm going to re-org them in the next content PR anyway. I just wanted to have a good stable commit before I started messing with the structure of content

@joseph-henry joseph-henry marked this pull request as ready for review September 12, 2023 15:36
@joseph-henry joseph-henry merged commit e788003 into main Sep 12, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@laduke laduke Awaiting requested review from laduke laduke is a code owner

@glimberg glimberg Awaiting requested review from glimberg glimberg is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@joseph-henry @glimberg @laduke