Docs should take a "functions first" approach
@negz is already working on this.
Since Aug 15, 2024.
Assessment
This issue has not been assessed yet.
Description
What's Missing?
Functions are the future of Crossplane's experience and how platform engineers should be composing resources. As we move towards making Functions GA, and even plan on deprecating classic patch and transform (https://github.com/crossplane/crossplane/issues/4746), we should be making them more of the "default" path when using Crossplane. New users of Crossplane should be using Functions from the very start of their Crossplane journey.
The most obvious place to update with a "functions first" approach would be the quick start guides that are still currently using classic patch and transform, e.g.:
Below will track a list of broad areas that we should be updating to use and evangelize Functions more aggressively:
### Topics to update
- [ ] https://docs.crossplane.io/v1.16/getting-started/provider-aws-part-2/
- [ ] https://docs.crossplane.io/master/getting-started/provider-azure-part-2/
- [ ] https://docs.crossplane.io/master/getting-started/provider-gcp-part-2/
- [ ] https://docs.crossplane.io/master/concepts/compositions/
- [ ] https://docs.crossplane.io/master/concepts/patch-and-transform/
- Dominant language
- SCSS
- Stars
- 60
- Forks
- 163
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 1
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from crossplane/docs
-
docs: fix 'allows to use' grammar in Composition compositeTypeRef notePossibly taken @mrchatam claimed this 22 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 95/100
crossplane/docs#1154 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
crossplane/docs#1153 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
crossplane/docs#1139 ·
-
[Web Bug] - Managed Resource Activation PoliciesPossibly taken @boxcee-interview claimed this 77 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
crossplane/docs#1126 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
crossplane/docs#1121 ·