Skip to content

Commit 9cc63bf

Browse files
authored
Update docs for archive site modifications (apache#56764)
Refreshed and clarified docs after running historical site modification update (remove Airflow Summit header). Related: apache/airflow-site-archive#23 Related: apache/airflow-site-archive#24
1 parent 1ba8c1d commit 9cc63bf

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

docs/README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -210,20 +210,24 @@ bad links or when we change some of the structure in the documentation. This can
210210
text editor, script, etc. Those files are generated as `html` files and are not meant to be regenerated,
211211
they should be modified as `html` files in-place
212212
3. Commit the changes to `airflow-site-archive` repository and push them to `some` branch of the repository.
213-
4. Run `Sync GitHub to S3` workflow in `airflow-site-archive` repository. This will upload the modified
214-
documentation to the S3 bucket.
215-
5. You can choose whether to sync the changes to `live` or `staging` bucket. The default is `live`.
213+
4. Create a Pull Request from that branch and merge it to `main`
214+
5. Run `Sync GitHub to S3` workflow in `airflow-site-archive` repository. This will upload the modified
215+
documentation to the S3 bucket. Use `main` branch (default) as "Reference of the commit used
216+
for synchronization". You can choose whether to sync the changes to `live` or `staging` bucket.
217+
The default is `live`:
218+
![Sync GitHub to S3](images/sync_github_to_s3.png)
216219
6. By default, the workflow will synchronize all documentation modified in a single last commit pushed to
217-
the branch you specified. You can also specify "full_sync" to synchronize all files in the repository.
218-
7. In case you specify "full_sync", you can also synchronize `all` docs or only selected documentation
220+
the `main`. You can also specify `full_sync` to synchronize all files in the repository if you want to
221+
make sure that S3 reflects `main`. The workflow might run for a long time (hours) in case of full sync
222+
or many changes to the `.html` files.
223+
7. In case you specify `full_sync`, you can also synchronize `all` docs or only selected documentation
219224
packages (for example `apache-airflow` or `docker-stack` or `amazon` or `helm-chart`) - you can specify
220-
more than one package separated by spaces.
221-
8. After you synchronize the changes to S3, the Sync `S3 to GitHub` workflow will be triggered
222-
automatically, and the changes will be synchronized to `airflow-site-archive` `main` branch - so there
223-
is no need to merge your changes to `main` branch of `airflow-site-archive` repository. You can safely
224-
delete the branch you created in step 3.
225-
226-
![Sync GitHub to S3](images/sync_github_to_s3.png)
225+
more than one package separated by spaces.
226+
8. The workflow will invalidate Cloudflare cache for "live" or "staging" bucket respectively.
227+
9. Run the "Build docs" workflow in `airflow-site` repository to make sure that Fastly cache of the
228+
https://airflow.apache.org or https://airflow.staged.apache.org/ invalidated. Use `main` to rebuild site
229+
for `live` site and `staging` to rebuild the `staging` site:
230+
![Build docs](images/build-docs.png)
227231

228232

229233
## Manually publishing documentation directly to S3

docs/images/build-docs.png

287 KB
Loading

docs/images/sync_github_to_s3.png

223 KB
Loading

0 commit comments

Comments
 (0)