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

Doc restructuring #196

Merged
merged 19 commits into from
Feb 20, 2024
Merged

Doc restructuring #196

merged 19 commits into from
Feb 20, 2024

Conversation

bglynn
Copy link
Contributor

@bglynn bglynn commented Feb 5, 2024 •
edited
Loading

Changes:

  • Redesigned root pages to serve as a launch pad for the rest of the docs
  • Organized the documents by getting started (root), features, overview, reference, security, FAQ
  • New LinkCard component
  • Added tailwind support to the docs
  • Redesigned the expand/collapse UI
  • CSS tweaks to improve cosmetics and discoverability
  • Removed length Otterize install instructions from each tutorial
  • Cleaned up inconsistencies
  • Redirects added for page relocations
  • Removed the Otterize Cloud / Object Model page and added new entries to the terminology page

New Content:

  • Otterize overview
  • Feature overview pages (these can probably be much improved)
  • Reference sections per feature
  • Straightforward IBAC description page based on the tone set in this blog article, but without it being exclusively network-focused

bglynn and others added 12 commits January 30, 2024 14:11
@bglynn
Initial restructuring to move towards a more linear user flow in the …
c28d99e 
…docs.
@bglynn
* Added support to tailwind in the documents
1af2eff 
* Access Type / AWS IAM Draft content
@bglynn
* "Features"
784d60d 
* Draft content for new getting started page
@bglynn
* Network overview and Reference pages
305f55c
@bglynn
* Kafka Overview / Reference
0ef28f3 
* PosgreSQL Overview / Reference
* Istio Overview / Reference
@bglynn
"/Examples" -> "/tutorials"
a6abf5d
@bglynn
* Added a smaller more value-add IBAC page.
ed435f9 
* Updates to tutorials
* Removed Otterize Cloud / Object model and added items to the terminology instead
* Removed logos with names
@bglynn
link updates.
e7ccbc8
@bglynn
more git issue fixes
856b036 
safari image issue
caps matter in vercel?
@bglynn
Another merge issue.
f8e2bae
@orishoshan
first pass
63ce824
@bglynn
PR Comments.
44cc1f6
bglynn and others added 7 commits February 7, 2024 15:34
@bglynn
some clean up
2430e53
@bglynn
some more clean up
15f9bec
@bglynn
updating broken paths.
f660f33
@orishoshan
Feature pages edits
ebbf963
@orishoshan
Merge branch 'main' of ssh://github.com/otterize/docs into bglynn/doc…
f9fbdd6 
…-restructuring
@orishoshan
Fixup
ac4470e
@bglynn
PR Comments.
ebbde39 
-Added redirect links for new tutorials
-Fixed broken includes for new tutorial
-examples of the otterize OSS CLI
-consistency of tutorial placement for feature overview pages
-Added ClientIntent reference link (looked for any similar issues, but didn't see any)
@bglynn bglynn merged commit f21909f into main Feb 20, 2024
2 checks passed
@bglynn bglynn deleted the bglynn/doc-restructuring branch February 20, 2024 16:56
@github-actions github-actions bot locked and limited conversation to collaborators Feb 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@orishoshan orishoshan orishoshan approved these changes

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

Successfully merging this pull request may close these issues.

None yet
2 participants
@bglynn @orishoshan