vmware-tanzu / cartographer-site Goto Github PK
View Code? Open in Web Editor NEWCartographer website
Home Page: https://cartographer.sh
License: Apache License 2.0
Cartographer website
Home Page: https://cartographer.sh
License: Apache License 2.0
A minor usability complaint.
AND
This works and is nice way to link to the latest docs whatever they are.
The problem is that the versioned url becomes the one that chrome autocompletes. User's who use their chore search bar to return to documents might type:
google: carto doc gvk
which will take them to https://cartographer.sh/docs/v0.3.0/reference/gvk even when 0.3.0 is out of date.
the latest docs always use the latest version tag links when navigating amongst them.
Docs for Deliverable and Workload (e.g. https://cartographer.sh/docs/v0.4.0/reference/workload/) show that they have a Status containing Conditions. Similarly so for their Resources.Conditions.
The values of Conditions that may appear in this list (condition types, possible condition statuses and reasons) are not documented anywhere.
Whilst Condition itself a generic, core k8s concept, intrinsic cartographer behavior for conditions like Ready, or cartographer feature-specific behavior for conditions like Healthy are not, and we should enumerate the condition types that cartographer knowingly populates. This became painfully obvious when trying to understand how to meaningfully consume the outcome of a Template's healthRules.
In doing so, to allow them to be easily consumed, we should:
This may have some overlap with this existing doc: https://cartographer.sh/docs/v0.4.0/troubleshooting/
When healthRules
were added to templates, new conditions were added. ResourcesHealthy
and ResourceHealthy
, appearing in owners (workload/deliverable) status
and resources[n].status
respectively. This isn't documented anywhere.
While #104 potentially deals with this by means of adding a reference to the documentation, the conditions surfaced in the owner are intended to help with troubleshooting, which has not been updated since this feature was added.
Troubleshooting doc should be improved to guide the user in assaying these new conditions.
Yarn not mentioned in dev dependencies.
Please provide a set of steps to reproduce the behavior (example):
make lint
As a contributor, when I've installed the development dependencies, I should be able to run the make commands.
/Library/Developer/CommandLineTools/usr/bin/make -C site lint
yarn install
make[1]: yarn: No such file or directory
make[1]: *** [dev-dependencies] Error 1
make: *** [lint] Error 2
Replace with Woke as per this pr
This section needs to include an explanation of selectorMatchFields and selectorMatchExpressions
When i see some useful base yaml in the docs, I often want to copy it, and i have to carefully select it (on some very long content) with my mouse
Code blocks in the docs have a 'copy to clipboard' button
Plenty of simple Hugo examples exist, this should be simple
As mentioned by Dodd Pfeffer here, the Cartographer documentation site lacks a search capability
just looking at open tabs our history, it's hard to figure out what a particular page from the documentation was about - they all have the same page title Documentation
.
IIUC, that's coming from the partial here
where we do end up using .Title
set to Cartographer for the landing page, but because of the lack of a .Title
in the other contexts, it ends up always being the same "Documentation" title.
I think it'd be great if for each page we had the title set to the root header (ala the h1
of that page's content), or something similar.
make use of Hugo's frontmatter for passing properties to the context? not really sure (I've used it a while ago, not sure what the best practices are)
When i visit the Carto Blog list at https://cartographer.sh/blog/ the blue heading is a link to the post, but I'm often inclinded to click the image above it. This should take me to the post as well.
On Page: Authentication
There's a link override the service account name
with the anchor #developer-selects-the-name-of-a-service-account-in-their-namespace
, but a heading matching that anchor does not exist. (broken link)
Since moving to cartographer-site, the Edit button is failing, it's still pointing to core cartographer.
In the documentation, the dropdown should have v0.1.x, v0.2.x, etc, (rather than v0.1.0, v0.2.0) to make it clear that the docs are intended for all patch versions in the minor version line.
We should make sure to update the install link to the latest patch as releases are cut
Let's also remove v0.0.6 and v0.0.7
As discussed in the June 1st community meeting, it would be great to have a page on the site with links to examples that are out there for cartographer.
It could contain examples such as the cartographer-catalog from TCE as a good example.
Ideally the page would have a simple edit button that would allow someone to open a PR directly and they could add the link to a repo and a short description of what the example includes.
This would allow showing the pluggability of cartographer as well as serve as a source of inspiration for many people on what they could do with cartographer in their own platforms.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.