jenkins-x / jx-docs

Source code used to build the Jenkins X documentation and website
http://jenkins-x.io/
Apache License 2.0
86 stars 358 forks source link

Docs navigation #2869

Closed vfarcic closed 3 years ago

vfarcic commented 4 years ago

I suggest the following navigation structure for the left-hand menu:

I believe that the proposed structure is self-explanatory. If it is not, it would mean that the structure is wrong, rather than that it requires additional explanation.

hferentschik commented 4 years ago

IMO we definitely need the concepts part back and another landing page into the docs. Right now there are concepts under "About" but that feels wrong.

hferentschik commented 4 years ago

https://istio.io/latest/docs/ could be an example/reference for a similar structure.

deanesmith commented 4 years ago

I am good with this. There are deep assumptions in the Infrastructure Setup section that would require substantial effort.

vfarcic commented 4 years ago

@deanesmith Those are only example items. The final ones would certainly differ.

sharepointoscar commented 4 years ago

Not sure if Operations replaces Guides but I feel we still need a Guides section that has multiple real-world scenario configuration guidance.

And the list goes on...

ankitm123 commented 4 years ago

Would be nice to have a production hardening sub-section under operations (similar to what hashicorp has: https://learn.hashicorp.com/vault/operations/production-hardening)

sharepointoscar commented 4 years ago

Would be nice to have a production hardening sub-section under operations (similar to what hashicorp has: https://learn.hashicorp.com/vault/operations/production-hardening)

Exactly @ankitm123 , this is the last bullet I added above.

jenkins-x-bot commented 4 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with /close. Provide feedback via https://jenkins-x.io/community. /lifecycle stale

jenkins-x-bot commented 3 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. If this issue is safe to close now please do so with /close. Provide feedback via https://jenkins-x.io/community. /lifecycle rotten

jenkins-x-bot commented 3 years ago

Rotten issues close after 30d of inactivity. Reopen the issue with /reopen. Mark the issue as fresh with /remove-lifecycle rotten. Provide feedback via https://jenkins-x.io/community. /close

jenkins-x-bot commented 3 years ago

@jenkins-x-bot: Closing this issue.

In response to [this](https://github.com/jenkins-x/jx-docs/issues/2869#issuecomment-730636494): >Rotten issues close after 30d of inactivity. >Reopen the issue with `/reopen`. >Mark the issue as fresh with `/remove-lifecycle rotten`. >Provide feedback via https://jenkins-x.io/community. >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [jenkins-x/lighthouse](https://github.com/jenkins-x/lighthouse/issues/new?title=Command%20issue:) repository.