Page tree
About: We're looking for problems with the documentation that need work. Out of date, incorrect, missing, old name, needs to move, needs versioning. This is a quick Punchlist.
Summary / NameDue Diligence PersonCreate/Keep/Trash/Update?StatusOwnerTargeted PersonaDescriptionOriginal URL / ReferenceUpdated Version
Documentation home page brandingIn progressJamesAllLink to Docs from the tungsten.io menu goes to a github.io site that looks and feels different than tungsten.io. Update: fixed this, but needs improvement in mobile browsers (e.g. hamburger icon in the header menu). Also we should move the main page to an index.md file and use the readme.md properly as a guide for those coming to the code in the repo.https://tungstenfabric.github.io/website/
Documentation home doesn't break out to all docs use casesAllA documentation home page should link out to all the use cases that something could want to use the docs such as reference of APIs, reference of concepts, features, getting started sandboxes, getting started as a developer, etc.https://tungstenfabric.github.io/website/
Getting started in 10 mintues needs updatingAll Rename: "10 Minute Tungsten Fabric Quick Start!"https://github.com/tungstenfabric/website/wiki/Tungsten-Fabric:-10-minute-deployment-with-k8s-on-AWS
Becoming a contributor broken linkContributing DevelopersIn the third item of this list, when clicking on "Create a Launchpad account", it sends me to a broken link where all I get is "Invalid OpenID transaction" error.https://tungstenfabric.github.io/website/
Include Helm deployment documentationIn the "Start using Tungsten Fabric" section, we could include documentation for a Helm-based deployment.https://tungstenfabric.github.io/website/
TF101 DeckCreatev1.0RandyNewbieshttps://drive.google.com/open?id=1gtZeM1IhL0krEr9XMIkcPQL_k480Nhpl
TF201 "Deep Dive" DeckCreateMVPRandyIntermediateshttps://docs.google.com/presentation/d/1E1cS0qPFX1YPgzXXx4CYH_mysc74G4l3HAI4MIUbMXE/edit?usp=sharing
TF Contributor DeckCreateMVPRandyNew contributorshttps://docs.google.com/presentation/d/1R6vaVNqC9j5OfmKyKvcSfOX71iGoG3yxfUcJRMDQnvI/edit?usp=sharing
RANDY'S NOTES BELOW
OC: Getting Started vs. Quick Start GuideGregAllAre these the same thing on the old OpenContrail.org site? Getting started page references quick start guidehttp://www.opencontrail.org/deploying-opencontrail/
Do we need a build guide?N/AContributing Developers, Packagers, & DistributorsWe have a contributor getting started, which should be expanded to include this informationhttps://github.com/tungstenfabric/docs/blob/master/Contributor/GettingStarted/getting-started-with-opencontrail-development.md
OC: Deploying OpenContrailGreg?Delete or roll into a build guidehttp://github.com/Juniper/contrail-controller and http://github.com/Juniper/contrail-vrouter
OC: Network Virtualization Architecture Deep DiveGregAllIs this still relevant? Is it up to date?http://www.opencontrail.org/network-virtualization-architecture-deep-dive/
OC: Architecture overviewGregUpdatev1.0Contributing DevelopersThis seems like a simple "architectural overview" that would ideally more front and center in terms of explaining to new contributors how the whole thing is wired together - probably needs an updatehttp://juniper.github.io/contrail-vnc/architecture.html
OC: OpenContrail Architecture DocumentStuart MackieTBDProbably needs an update; seems to overlap with eBook amongst other thingshttp://www.opencontrail.org/opencontrail-architecture-documentation/https://docs.google.com/document/d/12pQscvJ1roftoQfV9XK4Akxe5tXTlyGKah3P-ozhnmQ/edit?usp=sharing
OC: OpenContrail Architecture ("Day One") eBookGregTBDUpdate to TF; contact Ankur about doing the work on his behalfhttp://www.opencontrail.org/ebook/
Document graph/workflowRandyAllWhich docs for which personas at which times?TBD
OC: API documentation (all)GregAllRebase to Tungsten.io ; still need to rebrand ; move to readthedocs?N/A
OC: Installation guideRandyTBDFor Contrail 1.06?? Seems out of date but also potentially overlapping with getting started, quick start guide, deploying, and various othershttps://github.com/Juniper/contrail-controller/wiki/Install-and-Configure-OpenContrail-1.06
Personas we care aboutN/AN/AContributing developers (write code for TF), application developers (building their own apps on k8s+TF), network operators/engineers/architects
New TF CI infrastructure documentationRandyContributing DevelopersTBDhttps://github.com/Juniper/contrail-infra-doc
CC: Feature GuideRandyJNPR TechPubsTBD (will be committed to contrail-dcos) shortly
CC: Getting Started GuideRandyJNPR TechPubsTruncated CC: Feature GuideTBD (will be committed to contrail-dcos) shortly
CC: Release NotesRandyJNPR TechPubshttps://github.com/Juniper/contrail-docs/tree/master/doc/release-notes
CC: READMERandyEngineering after 5.1 releaseDockerHub item, it is not depricated, it is simply no longer distributed as Contrail docs from 5.1 onwardshttps://www.juniper.net/documentation/en_US/contrail5.0/information-products/topic-collections/release-notes/readme-contrail-50.pdf
OC: Eng WikiRandyhttps://github.com/Juniper/contrail-controller/wiki
What 302 redirects will we need?James
Clickable mapJames
New TF DatasheetRobert