Upbound Docs v2.0
Home Page: https://docs-upboundio.vercel.app
License: Creative Commons Attribution Share Alike 4.0 International
This repository is the home of the Upbound documentation.
For information on contributing read the Contributor's Guide.
The Upbound Vale repository is at upbound/vale.
There needs to be a way to flag issues in other projects need docs. For example upbound/up#185
Initial thought is to have a tag on the issue and a bot to create doc issues based on the tag.
We need to document how to deploy Upbound with ArgoCD.
https://github.com/n8sOrganization/UpboundCloud-ArgoCD/tree/main
The box is the same color grey as the code blocks, making it just blend into the page with all the outputs. We need some styling around the element to make it easier to see.
https://main.d3354a0tuonchv.amplifyapp.com/uxp/#customize-install-options
We need a doc on how to migrate clusters running on community providers can migrate to official providers.
We need a complete example showing the deployment of an application and infrastructure from a Helm chart.
Some apps that may be worth porting to use:
https://github.com/ACloudGuru-Resources/Course_Practical_Guide_EKS
https://github.com/secureCodeBox/secureCodeBox/tree/main/demo-targets/swagger-petstore
https://github.com/upbound/se-repo/tree/main/configs/aws/plat-ref-official/test-aws-plat
https://github.com/upbound/platform-ref-aws
https://github.com/mreferre/yelb
https://github.com/vmwarecloudadvocacy/acme_fitness_demo
https://github.com/pulumi/examples/tree/master/aws-py-voting-app
Using Chrome 104.0.5112.79 on Mac OS 12.4
When setting Chrome to auto dark mode with chrome://flags/#enable-force-dark the dark mode button does not work properly.
This video demonstrates the problem.
First I reload the page.
Then I click the dark mode button and the page reloads.
Then I can no longer click the dark mode button.
@jastang updated the Postgres engineVersion field inside the getting started package with upbound/universal-crossplane#238.
However, we missed also updating the content of the docs that has this value too. The docs page is below, search the page for engineVersion:
https://cloud.upbound.io/docs/uxp/build-configuration/#define-a-composite-resource
It should match what's in https://github.com/upbound/universal-crossplane/blob/main/docs/getting-started/configuration/composition.yaml#L139.
Problem
Suggested Fix
Could we move the search box and make it more central to the UI? I really like how Pulumi does it https://www.pulumi.com/docs/get-started/kubernetes/
The old docs site at cloud.upbound.io/docs needs to have a 301 redirect to docs.upbound.io
Docs will move away from cloud.upbound.io/docs to either docs.upbound.io or upbound.io/docs.
Need to decide where and implement.
A CNAME record to redirect docs.upbound.io to the amplify URL needs to be implemented.
related: https://github.com/upbound/platform-core/issues/402
https://github.com/upbound/upbound-docs/issues/233
This is likely a KB but may fit under the future UXP upgrade/install chapters.
Now that the official providers are live, the Big Three quickstart guides need to be updated with proper manifests for the Provider configuration and instructions on how to generate a robot token and use it to create a k8s secret.
More info in Dan's page
https://www.notion.so/upbound/Official-Providers-ceb08463b29e468e989f102f1653ea3e
Need to evaluate and choose a hosting provider and connect to this repo for publishing.
#42 should cover a very detailed walk through of the components, the reasoning and the "how".
The starting point should be a "speed run" to build this. What to execute and how to verify. This would be a shorter time to publish than the full example that it would grow into.
Create the knowledge-base section of pages. This requires Unomena to update the design to support multiple products in the top nav.
Example of the layout update.
)
At completion the "KB is a work in progress" note in the contributors guide should be removed.
Support a shortcode that produces an image+text carousel for multi-step instructions.
Consider implementing Chatlio slack chatbot to help users.
https://main.d3354a0tuonchv.amplifyapp.com/providers/ -- the support sections should be it's own page
Tracking the work being done for the new docs.upbound.io site.
Work assigned to Unomena is tracked in their Jira issue
https://upbound-unomena.atlassian.net/browse/UP-75
Transition all existing cloud.upbound.io/docs pages to Hugo markdown has been completed in this repo.
How do existing upbound users migrate from community providers to official providers?
We are likely going to use the Hugo Book Theme as the basis for the site.
The book theme needs to be installed and validated in the repo.
URL
All
Problem
Suggested Fix
I'd really like it if the sidebar were pinned and didn't scroll with me as I moved down the page. That would make jumping between pages easier. Similarly, I'd like to be able to independently scroll in the sidebar so I could find topics more easily.
Epic #10
For the new docs.upbound site we need to determine the proper licensing.
I suggest Creative Commons CC-BY-SA. We could also do CC BY-NC-SA if we want to enforce "non-commercial" copying.
Comparisons:
Select and reskin a Hugo theme.
https://main.d3354a0tuonchv.amplifyapp.com/uxp/#customize-install-options
The expand box doesn't size down or give a horizontal scroll for the wider outputs in this table.
Outputs in single ticks are hard to read in dark mode.
Add the upbound CLA to the repo.
Provide details on UXP scale testing/limitations, deployment best practices and other deployment related considerations.
Epic #10
Implement Google Analytics. Same tool used by marketing for upbound.io
Epic #13
The existing Getting Started section needs to be reorganized. A lot of existing content can be reused.
Customers concerned about security prefer it if UXP didn't store their cloud account credentials. In the upstream docs, there exists a guide showing how to use the Vault Kubernetes Sidecar (which lives in the same cluster as XP) to inject secrets into ProviderConfigs.
We should show users how to do this for all authentication mechanisms supported in our Providers.
Need a page with instructions about hugo, vale, shortcodes and branches. What folks need to know in order to contribute to the docs.
triple tick code blocks render grey text in a grey box and it's hard for some users to see.
Each page needs a right-hand table of contents similar to what is used in the Hugo Book theme.
Epic #13
https://cloud.upbound.io/docs/upbound-cloud
Clean up and detail various screens and configurations.
Automate screenshot captures
The existing docs.upbound.io/docs content needs restructuring and editing. This Epic tracks that work.
Proposed sections:
How can Upbound use Vault for secrets management?
Create documentation describing AWS IAM policies for the official provider.
https://github.com/crossplane-contrib/provider-aws/tree/master/examples/providerconfig
Contributor licensing agreement needs to be added to the repo before accepting PRs.
Related to https://github.com/upbound/squad-prodeng/issues/1000
Yury updated the configuration files for the UXP chapter and they need to be folded into the docs.
https://github.com/upbound/universal-crossplane/pull/279/files
Epic: #13
Update the UXP chapter.
Universal Crossplane (UXP)
Installing
Authentication options
Upgrading
React
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
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
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.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.
