docs(TF-409): deployment configuration #7398

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.

Sign up for GitHub

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

Jump to bottom

Merged

filrak merged 18 commits into docs/multibrand from docs/tf-409-deployment

Feb 25, 2025

Contributor

jagoral commented Feb 18, 2025

No description provided.

jagoral added 3 commits

February 18, 2025 17:04


          docs(TF-409): deployment

82d302a


          Merge branch 'docs/multibrand' of https://github.com/vuestorefront/vu…

8f63927

…e-storefront into docs/tf-409-deployment


          docs: update security parts

7531a30

changeset-bot bot commented Feb 18, 2025 •

edited

Loading

⚠️ No Changeset found

Latest commit: 8ee4724

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR


          fix: nextjs instead of next

3213ec2

jagoral requested review from grixu, mateuszo and filrak

February 18, 2025 11:36


          chore: docker registry url

ae399b6

grixu reviewed

View reviewed changes

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Outdated Show resolved Hide resolved

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Show resolved Hide resolved

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Outdated Show resolved Hide resolved

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Show resolved Hide resolved

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Outdated Show resolved Hide resolved

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Show resolved Hide resolved

jagoral added 5 commits

February 19, 2025 16:23


          chore: refactor what you'll learn

89120e4


          docs: framework auto-detection

26dabf7


          docs: mention .env file

be0201f


          docs: decouple from a ci provider

dd5cdfc


          docs: region warning

572fe82

jagoral force-pushed the docs/tf-409-deployment branch from 1ba9003 to 572fe82 Compare

February 19, 2025 09:36


          docs: deployment variables reference

100e831

jagoral requested a review from grixu

February 19, 2025 10:00

jagoral added 2 commits

February 19, 2025 17:11


          docs: move prerequisites at the beginning of the section

b2a9022


          Merge branch 'docs/multibrand' of https://github.com/vuestorefront/vu…

517d4b3

…e-storefront into docs/tf-409-deployment

mateuszo reviewed

View reviewed changes

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md

+              }
+              ```
+              ### `region`

Contributor

mateuszo Feb 20, 2025

It's more about the implementation rather the documentation, but this begs the question: "Why do I have to specify the region when I already have the projectName?". I guess, it's easier this way, or the projectName is not globally unique.

Contributor Author

jagoral Feb 20, 2025 •

edited

Loading

I think that's because we support (at least theoretically) multi regions, but that's a very good question https://docs.alokai.com/cloud/introduction/features#multi-regions

Contributor

grixu Feb 20, 2025

@mateuszo Yes, we need it - each instance has assigned region. We support multi-region in meaning that you can have instances per different region. One in US, another in Europe, third in Australia. But each of them are separate instances. Confirmed with Cloud Team 👍

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Outdated

+. **Cloud Credentials**
+                 - Find your credentials in the [Alokai Console](/console/instance/settings/deployment-variables)
+                 - Use staging projects for local testing

Contributor

mateuszo Feb 20, 2025

What is a "staging project"?

Contributor Author

jagoral Feb 20, 2025

oh, I was thinking about staging environment xd changed feac843

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Outdated

+              - You're migrating from one framework to another
+              - Specific stores have requirements better suited to a particular framework
+              ## Local Test Deployments

Contributor

mateuszo Feb 20, 2025

The name "Local Test Deployment" is misleading. My first impression was that we deploy it to local docker not the cloud. What it does in fact is: build a storefront locally and deploy from the command line.
Maybe we could call it: "Local build & deployment via CLI"

Contributor Author

jagoral Feb 20, 2025

Updated 27ded58

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Outdated Show resolved Hide resolved

jagoral and others added 4 commits

February 20, 2025 17:14


          Update docs/content/guides/6.multistore/2.tooling-and-concepts/4.depl…

55f9478

…oyment/7.configuration.md

Co-authored-by: Mateusz Ostafil <mostafil@alokai.com>


          chore: staging env

feac843


          Merge branch 'docs/tf-409-deployment' of https://github.com/vuestoref…

c37b26f

…ront/vue-storefront into docs/tf-409-deployment


          chore: local testing -> triggering local deployment

27ded58

jagoral requested a review from mateuszo

February 20, 2025 10:30

grixu approved these changes

View reviewed changes

Contributor

grixu left a comment

Great job @jagoral 👏 💪

filrak requested changes

View reviewed changes

docs/content/guides/6.multistore/2.tooling-and-concepts/4.deployment/7.configuration.md Outdated Show resolved Hide resolved

jagoral requested a review from filrak

February 24, 2025 13:55


          docs: change introduction

8ee4724

sonarqubecloud bot commented Feb 25, 2025

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

filrak approved these changes

View reviewed changes

filrak merged commit d3b7ca0 into docs/multibrand

3 checks passed

filrak deleted the docs/tf-409-deployment branch

February 25, 2025 12:34

grixu added a commit that referenced this pull request


          docs: multibrand (#7407)

1916f9f

* 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 <f.rakowskI@hotmail.com>

* Update docs/content/guides/6.multistore/2.tooling-and-concepts/2.file-based-inheritance.md

Co-authored-by: Filip Rakowski <f.rakowskI@hotmail.com>

* docs: change store type namings

* docs: change order of what you'll learn

* docs: add diagram

---------

Co-authored-by: Filip Rakowski <f.rakowskI@hotmail.com>

* 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 <richard.t.rohrig@gmail.com>
Co-authored-by: Mateusz Ostafil <mostafil@alokai.com>

* 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 <mostafil@alokai.com>

* chore: remove ci part

---------

Co-authored-by: Mateusz Ostafil <mostafil@alokai.com>

* 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 <mostafil@alokai.com>

* chore: staging env

* chore: local testing -> triggering local deployment

* docs: change introduction

---------

Co-authored-by: Mateusz Ostafil <mostafil@alokai.com>

* 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 <tomasz.gl69@gmail.com>
Co-authored-by: Filip Rakowski <f.rakowskI@hotmail.com>
Co-authored-by: rohrig <richard.t.rohrig@gmail.com>
Co-authored-by: Mateusz Ostafil <mostafil@alokai.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet