GetJobber / atlantis

🔱 Atlantis
https://atlantis.getjobber.com
MIT License
27 stars 30 forks source link

docs(components): Document composability best practices [107012] #2136

Closed Aiden-Brine closed 1 day ago

Aiden-Brine commented 1 week ago

Motivations

There has been a lot of discussion and work around making our Atlantis components more composable. We decided it would be a good idea to get some documentation added for consumers to better understand our philosophy towards customization and our approach.

Changes

Added

New documentation

Changed

Deprecated

Removed

Fixed

Security

Testing

N/A

Changes can be tested via Pre-release


In Atlantis we use Github's built in pull request reviews.

Random photo of Atlantis

cloudflare-workers-and-pages[bot] commented 1 week ago

Deploying atlantis with  Cloudflare Pages  Cloudflare Pages

Latest commit: dabe1a9
Status: âœ…  Deploy successful!
Preview URL: https://5c3cafa2.atlantis.pages.dev
Branch Preview URL: https://job-107012-composability-doc.atlantis.pages.dev

View logs

ZakaryH commented 6 days ago

overall I'm thinking about who this guide is for, or what persona.

I would say most of our guides are for people looking to learn about Atlantis and use it.

we have very little, if any content, for Atlantis internal dev team about decision making so I'm not sure this is the best place for that type of content though I do think we should document that!

also looking around the docs site I found a section about composing components. I think this link is broken, or I don't get why it is a standalone section at the very least

https://atlantis.getjobber.com/space?path=/story/guides-getting-started-with-react--composing-components

that aside, we do have a section about composition https://atlantis.getjobber.com/space?path=/docs/guides-getting-started-with-react--docs#composing-components

I'm thinking the guides on how to customize Atlantis components, or compose them might be a better fit there

ZakaryH commented 1 day ago

still LGTM since I know we don't remove the approved status after a commit (we probably should)