magazine/fedora-magazine
1
1
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions

Theme: Update documentation show how to use Podman instead of Vagrant

Browse source
This commit is contained in:
Gregory Lee Bartholomew 2022-05-15 18:57:20 -05:00
commit 11e85edf23
1 changed files with 28 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

30
modules/ROOT/pages/technical-theme.adoc
View file

@ -1,14 +1,36 @@
= Maintaining the Magazine Theme
The Magazine theme is maintained in https://pagure.io/fedoramagazine-theme[a Pagure repository]. If you want to submit a change, start by forking and/or cloning this repository. This page does not cover git workflow; consult https://git-scm.com/doc[git documentation] for more information, or ask the Magazine staff for help.
The Magazine theme is maintained in
https://pagure.io/fedoramagazine-theme[a Pagure repository].
If you want to submit a change, start by forking and/or cloning this repository.
This page does not cover git workflow;
consult https://git-scm.com/doc[git documentation] for more information,
or ask the Magazine staff for help.
== Testing your changes
The `Vagrantfile` lets you deploy a test system to try out your work before you deploy. Ensure you are in the cloned repository in the same directory as the `Vagrantfile`, and run the command `vagrant up` to create and provision the box. This will take some time.
The `build.sh` and `preview.sh` scripts let you deploy WordPress in a local container
to test your work before you push your changes to the live site.
Ensure you are in the root of the cloned repository and enter
`./build.sh && ./preview.sh` to create and provision the container.
This will take some time.
When done, you can point your local browser at http://localhost:5055 to see the theme in action on a test site. The Vagrant box accesses the contents of the repo directly, so you can edit changes in the repository and quickly see them in action. To iterate on changes, after modifying the theme, run `vagrant ssh -- systemctl reload httpd` so the Vagrant box's web caching is cleared. Then reload on your browser to see the modifications at work.
When done, you can point your local browser at http://localhost:5055
to see the theme with your local revisions.
The container accesses the contents of the repo directly,
so you can edit changes in the repository and quickly see them in action.
To iterate on changes, after modifying the theme,
run `podman restart wordpress` from another terminal window
so the containers's web caching is cleared.
Then refresh your browser window (F5 or Ctrl+F5) to view the modifications.
When finished, run `vagrant halt` to stop the Vagrant box, or `vagrant destroy` to remove it from your system entirely.
When finished, press **Ctrl**+**C** in the original terminal window
from which you launched the container to stop the container.
Optionally, you can run `./clean.sh` to remove all the contianer artifacts
except for the repo itself from your system.
If you remove all the artifacts (WordPress plugins, databases, etc.)
it will take longer to run the `build.sh` and `preview.sh` commands the
next time because everything will need to be re-downloaded and re-installed.
== Tagging the theme