search

openziti / ziti-doc

Documentation describing the usage of the Ziti platform.
https://openziti.io
Apache License 2.0
34 stars 40 forks source link

update/remove example configs #152

Closed dovholuknf closed 1 year ago

dovholuknf commented 2 years ago

https://openziti.github.io/ziti/manage/sample-controller-config.yaml https://openziti.github.io/ziti/manage/sample-edge-router-config.yaml

found under the manage menu are very much out of date. either update them with one that the quickstart generates, remove the nodes, or fix the doc correctly

image

cnu1812 commented 1 year ago

Here is the example configuration file link https://github.com/openziti/ziti/blob/release-next/etc/ctrl.with.edge.yml, but I'm not finding this file in this repo.

dovholuknf commented 1 year ago

right now, when the ./gendoc.sh script runs, part of that script will go out and clone sub-repos. the /ziti repo is one of those repos. In this repo you'll find that node by running this from the root:

grep "Configuration File Example" -r docfx_project/ziti
docfx_project/ziti/manage/toc.yml:  - name: Configuration File Example
docfx_project/ziti/manage/toc.yml:    - name: Configuration File Example
docfx_project/ziti/manage/toc.yml:#    - name: Configuration File Example

so the docfx_project/ziti/manage/toc.yml file contains this entry....

Now to complicate matters, I'm actively (as in it's what i'm working on right now) in the midst of moving our docs away from docfx and into docusaurus. You can find that new site currently under /docusaurus of the main site: https://openziti.github.io/docusaurus

In that site i've not replicated these nodes, so... in a way i've already fixed this particular issue too. :( I've not closed this issue yet, since I've not moved us over to docusaurs yet...

So - if you want to fix this for hacktoberfest - i would accept it :) it's not labeled as hacktoberfest yet but I could take care of all that.

Hope that all makes sense. Thanks for checking out the issue list! We appreciate the 👀 :)

cnu1812 commented 1 year ago

You are moving this project to docusaurus wow. I'm gonna involve in this from now. And would like to contribute to this repo https://openziti.github.io/docusaurus .

dovholuknf commented 1 year ago

i haven't updated the readme.md yet, but you can pull and checkout the main branch. after doing that you should run ./gendoc.sh -cd to pull down all the dependencies (if you don't you'll get a build warning when running docusaurus)

After that, you can cd docusaurus and run yarn start to fire up the site and see it locally. lmk if you have questions.

dovholuknf commented 1 year ago

oh and if you're going to make any changes - make sure you run yarn build before putting a PR up to make sure it all works properly :)

cnu1812 commented 1 year ago

Thank you @dovholuknf for explaining this. I too have some experience working with docusaurus. So ig I'll make it!

cnu1812 commented 1 year ago

hi @dovholuknf , I noticed that sidebar is similar for all the nav bar items. Screenshot 2022-09-29 092308 Is there any thought on changing that, if so I would like to work on that? Thank You!

dovholuknf commented 1 year ago

It's a very rough work in progress right now that I'm working on this week. I have been trying to keep the sidebar auto generated to make contributions easier. I plan to reorganize it, it's getting a bit large.

What sort of changes were you thinking?

cnu1812 commented 1 year ago

It's a very rough work in progress right now that I'm working on this week. I have been trying to keep the sidebar auto generated to make contributions easier. I plan to reorganize it, it's getting a bit large.

What sort of changes were you thinking?

like we have currently and removing getting started and replace with articles

dovholuknf commented 1 year ago

I am sorry but I can't seem to have the same vision in my head that you're proposing. If you could mock it up, maybe I could understand better. It might be worthwhile to wait a couple of days though since I'm very active in there right now.

My goal is to simply present the material in as clear a way possible. I feel like there's some organization of terms that will need to happen. I feel like the sidebar has too many top level items.

dovholuknf commented 1 year ago

i've had to remove the nodes today - sorry @cnu1812 , they were getting referenced by users. I've removed them from the doc site. thanks for looking at this issue though. the docusaurus merge for docs will be soon.