-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Take Ownership section is now complete and matches rest of the docs #34
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.
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
base: main
Are you sure you want to change the base?
Conversation
|
|
||
| A robust CI/CD pipeline is essential for a healthy and scalable 1fe ecosystem. You'll create reusable CI/CD templates that ensure consistent quality and deployment processes across all your widgets and your 1fe app. | ||
|
|
||
| ## 📦 For Widget Repositories |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think some sort of explanation here which sys that one of the features is shared ci/cd pipelines and if you followed the setting up POC tutorial, then you would have our shared templates being used. Either fork that if you want to re-use our's or create your own based on your providers.
|
|
||
| # <SlShield style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle' }} /> Step 3: Customize with Shell Types | ||
|
|
||
| 1fe allows you to provide custom utilities, services, and other `platformProps` to your widgets. To ensure type safety and an excellent developer experience, you'll create and publish your own shell types package that reflects your organization's specific platformProps. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
again, can you talk a bit about how out of the box, you are referencing the 1fe's basic platform props and this is a good thing to own as you will be adding custom utilities.. Show them the path where these live and what they need to change to take over ownership?
|
|
||
| ## <SlUser style={{ display: 'inline', marginRight: '0.5rem', verticalAlign: 'middle' }} /> Who is this for? | ||
|
|
||
| This tutorial is designed for **platform teams** who need to: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would mention that coming off of the POC tutorial, the 1fe instance which was provisioned still has some hooks into the demo instance provided by the 1fe team. This tutorial is for us to introduce key area's where a platform team should have ownership before they productionize or open their 1fe instance to the wider organization.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point. Can you help identify the exact places where the POC still uses 1fe demo URLs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- shared config's..
- Links to shared ci cd template of our's ..
- Touch point's for importing default utils from 1ds/shell.
Here is a preview
https://www.loom.com/share/f56782bf6e204b4e94e90cd1dffdedd5?sid=0faa9e32-268c-47f3-9e93-b5926d0b93af
The docs will be made more concise in the future but what this PR adds is in line with the existing docs in terms of language, tone, structure and organization.
This PR also makes some fixes elsewhere.