backdrop-ops / docs.backdropcms.org

Website for displaying Backdrop CMS documentation and API source code.
https://docs.backdropcms.org/
6 stars 6 forks source link

Versioned extra directory - doesn't make sense #201

Closed yorkshire-pudding closed 2 years ago

yorkshire-pudding commented 2 years ago

On https://docs.backdropcms.org/documentation/versioned-extra-directory

It states the following:

config/
config/active
config/staging
config/versioned <-- track via Git

Then later says:

Deploying to prod - moving upstream local: Manually delete all files in the versioneddirectory. local: Manually copy the all the files from the active directory into the versioned directory. local: git add & git commit all files in staging. local: git push to get all files into the Git repository. production: git pull to pull all config changes onto the production server. production: Manually copy the all the files from the versioned directory into the staging directory. production: Run the config importer (via Backdrop UI). When you git pull on the production server, the staging directory is unchanged. The config files must be manually copied from the versioned directory before they will be ready for import via the Backdrop UI.

And:

Sync local to prod - moving downstream production: Manually delete all files in the versioned directory. production: Manually copy the all the files from the active directory into the versioned directory. production: git add & git commit all files in staging. production: git push to get all files into the Git repository. local: git pull to pull all config changes onto the production server. local: Manually copy the all the files from the versioned directory into the staging directory. local: Run the config importer (via Backdrop UI).

We are copying files in versioned but then doing git with staging; that's not going to work

Or am I missing something?

yorkshire-pudding commented 2 years ago

What I think it should say is:

Deploying to prod - moving upstream local: Manually delete all files in the versioned directory. local: Manually copy the all the files from the active directory into the versioned directory. local: git add & git commit all files in stagingversioned. local: git push to get all files into the Git repository. production: git pull to pull all config changes onto the production server. production: Manually copy the all the files from the versioned directory into the staging directory. production: Run the config importer (via Backdrop UI). When you git pull on the production server, the staging directory is unchanged. The config files must be manually copied from the versioned directory before they will be ready for import via the Backdrop UI.

And:

Sync local to prod - moving downstream production: Manually delete all files in the versioned directory. production: Manually copy the all the files from the active directory into the versioned directory. production: git add & git commit all files in stagingversioned. production: git push to get all files into the Git repository. local: git pull to pull all config changes onto the production server. local: Manually copy the all the files from the versioned directory into the staging directory. local: Run the config importer (via Backdrop UI).

ghost commented 2 years ago

Yep, looks like step 3 for both sections should say 'versioned' instead of 'staging'.

Also, I think step 5 from the second section should say "onto your local" instead of "onto the production server".

yorkshire-pudding commented 2 years ago

Good point @BWPanda, so in all it should say:

Deploying to prod - moving upstream local: Manually delete all files in the versioned directory. local: Manually copy the all the files from the active directory into the versioned directory. local: git add & git commit all files in stagingversioned. local: git push to get all files into the Git repository. production: git pull to pull all config changes onto the production server. production: Manually copy the all the files from the versioned directory into the staging directory. production: Run the config importer (via Backdrop UI). When you git pull on the production server, the staging directory is unchanged. The config files must be manually copied from the versioned directory before they will be ready for import via the Backdrop UI.

And:

Sync local to prod - moving downstream production: Manually delete all files in the versioned directory. production: Manually copy the all the files from the active directory into the versioned directory. production: git add & git commit all files in stagingversioned. production: git push to get all files into the Git repository. local: git pull to pull all config changes onto the production serveryour local. local: Manually copy the all the files from the versioned directory into the staging directory. local: Run the config importer (via Backdrop UI).

yorkshire-pudding commented 2 years ago

Correction completed. Closing