docs(TF-410): multibrand ci/cd #7401
Conversation
|
docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/8.ci-cd.md
Outdated
Show resolved
Hide resolved
docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/8.ci-cd.md
Outdated
Show resolved
Hide resolved
|
|
||
| Here's how our setup action is defined: | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
How could we have this in sync with the original file? To avoid having an outdated docs 🤔
There was a problem hiding this comment.
that's a valid question.. As this is a general problem in our docs, and we don't have a solution for it, I've decided to describe the setup action on a high level 6f44a36
docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/8.ci-cd.md
Outdated
Show resolved
Hide resolved
docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/8.ci-cd.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
This is great. However, I'm not sure whether this should be in the public documentation. On one hand, I'm not keen on hiding any information, but on the other knowledge presented here might give an incentive to our customers to build their own pipelines and deploy to their own infra, what is AFAIK not what we want. Or, even they might even be deploying to our cloud but with a custom pipeline and I don't think we want to support that - IMHO it creates a new bug category. Lastly, I find this as our secret sauce ;) we give it for free here and make our service look less like a service.
WDYT @filrak ?
docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/8.ci-cd.md
Outdated
Show resolved
Hide resolved
| - Efficient resource usage | ||
| - Reduced redundancy (unchanged stores are skipped in CI/CD pipeline) | ||
|
|
||
| ## Continuous Integration (CI) |
There was a problem hiding this comment.
Having all the steps listed here and explained briefly would be nice. An image visualizing this would be superb ;)
…oyment/8.ci-cd.md Co-authored-by: Mateusz Ostafil <[email protected]>
|
@mateuszo I think this docs might be helpful for customers who don't use Github Actions. If we don't provide CI/CD for other providers (like Gitlab, Bitbucket, Jenkins), they can use this page to build it on their own |
| yarn store test --store-id $STORE_IDS | ||
| ``` | ||
|
|
||
| ## Continuous Deployment (CD) |
There was a problem hiding this comment.
We decided with @mateuszo that the points above this one are too detailed and we should keep them internally for our team. It could indeed make it much easier to leave Alokai.
There was a problem hiding this comment.
So should then make a CI workflow a blackbox? Right now, all the code, which I describe here, will be delivered to the customer anyway
There was a problem hiding this comment.
We want to ensure that you understand that the client will still receive this code, so if necessary it can be migrated when they understand it. Unless it’s us who don’t understand the case you’re referring to, in which case that’s fine. In any event, we just want confirmation that we are all on the same page and understand the consequences both of removing this from the docs and that the client still receives this code.
There was a problem hiding this comment.
I'm fine with keeping the code white-boxed. I hope that the consequences of leaving this part undocumented would be that nobody touches that.
Anyway, I don't have a strong opinion on removing this. It just makes the feature look more complex and non-service-like to me ;)
There was a problem hiding this comment.
I guess we can black-box it later on, for now this seems to be an easy fix for what @mateuszo raised. Let's keep it on confluence tho
There was a problem hiding this comment.
ok, I removed the CI part and moved it to the Confluence
|
* feat: lay foundation (#7381) * docs(TF-404): file based inheritance (#7389) * docs(TF-404): file based inheritance * fix: title case * docs: describe base apps * docs: story telling * docs: describe project name and cloud region * docs: include esling config, prettier and tailwind * docs: concise moving stores * docs: remove storefront-cli fragments * docs: file basde inheritance update * docs: mark direct and inheritance stores * docs: move and expand the file resolution process * docs: update file override system example * Update docs/content/guides/6.multistore/2.tooling-and-concepts/2.file-based-inheritance.md Co-authored-by: Filip Rakowski <[email protected]> * Update docs/content/guides/6.multistore/2.tooling-and-concepts/2.file-based-inheritance.md Co-authored-by: Filip Rakowski <[email protected]> * docs: change store type namings * docs: change order of what you'll learn * docs: add diagram --------- Co-authored-by: Filip Rakowski <[email protected]> * docs(TF-407): adding integration tests (#7393) * docs(TF-407): adding integration tests * chore: add missing img * fix: overriding base test * chore: turn file names into comments * docs: expand on overriding the file * docs: move integration tests explanation to the beginning * fix: syntax error * docs(TF-405): managing the stores (#7391) * docs(TF-406): local development (#7390) * docs: Introduction to multibrand (#7382) * new homepage for guides * rewritten home page * hide sidebar as its unnecessary * phase 1 for introduction docs * use cases pt2 * formatting improvements * add "next" btn * updated use cases section * updated the use cases story with solutionsupdated use cases * even more content yay * more content * almost final intro * images * images adjusted * done! * update main page * update cookbook * update home * update home * subtle improvements to visual interlinking * feat: improve Multistore guide * feat: improve Multistore guide2 * Add TL;DR (#7397) Add tldr at the beginning of the guide so that developers can jump straight into the practical part if they want to. * Update docs/content/guides/6.multistore/1.introduction/1.index.md --------- Co-authored-by: rohrig <[email protected]> Co-authored-by: Mateusz Ostafil <[email protected]> * docs(TF-408): how deployment works (#7400) * docs(TF-408): how deployment works * chore: add link to file-based inheritance * docs: maximum compatibility * chore: elaborate more on independent versions * docs(TF-410): multibrand ci/cd (#7401) * docs(TF-410): ci/cd draft * docs: complete docs * chore: which stores have changed * docs: improve introduction * docs: describe a setup action on a higher level * Update docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/8.ci-cd.md Co-authored-by: Mateusz Ostafil <[email protected]> * chore: remove ci part --------- Co-authored-by: Mateusz Ostafil <[email protected]> * docs(TF-409): deployment configuration (#7398) * docs(TF-409): deployment * docs: update security parts * fix: nextjs instead of next * chore: docker registry url * chore: refactor what you'll learn * docs: framework auto-detection * docs: mention .env file * docs: decouple from a ci provider * docs: region warning * docs: deployment variables reference * docs: move prerequisites at the beginning of the section * Update docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Co-authored-by: Mateusz Ostafil <[email protected]> * chore: staging env * chore: local testing -> triggering local deployment * docs: change introduction --------- Co-authored-by: Mateusz Ostafil <[email protected]> * chore: clean up * Comment out CDN in data fetching guide (#7404) * docs: add best practices collection and data fetching guide * docs: add data fetching examples * docs: explain why not to fetch lazy loaded data server side * docs: comment out info about CDN * docs: update handling custom occ endpoints recipe (#7405) * fix: guides * remove icons and add descriptions * remove link to patterns from cli reference * move performance to best practices * Imp. descriptions in best practices * fix: missing description * fix: not working image * fixes for image and missing next step * change button to arrow link in file inheritance doc --------- Co-authored-by: Tomasz Góral <[email protected]> Co-authored-by: Filip Rakowski <[email protected]> Co-authored-by: rohrig <[email protected]> Co-authored-by: Mateusz Ostafil <[email protected]>
No description provided.