| commit | 4d1ce3ab032da87bc142c50d2c15c1e0e2cd22a9 | [log] [tgz] |
|---|---|---|
| author | Andrew Wetmore <andrew@cottage14.com> | Sun Jul 24 09:39:00 2022 -0300 |
| committer | GitHub <noreply@github.com> | Sun Jul 24 09:39:00 2022 -0300 |
| tree | 86a021fc5db590bef284ad9876afa72a9c698c3f | |
| parent | 12f82c8f78c65af8a13951a5a20581d8ebbb4e69 [diff] |
Update index.md Made a slight change to the text about issue trackers.
This repository provides the source for the main website of The Apache Software Foundation.
Branches. Note that .asf.yaml is set up for autopreview. A branch named preview/mytest for example is automatically staged at https://www-mytest.staged.apache.org/
Markdown (.md) files appear in the preview pane of the editor approximately as they will appear in the generated website. This is convenient for reviewing changes, but means that linking to the source requires a bit more work compared with other files. If you want to create a permalink or raise an issue that relates to a particular Markdown source line, proceed as follows:
Read the Getting started guide and the pages it links to.
The website is built with Pelican.
You can use the infrastructure-pelican Dockerfile build the website locally for testing.
Continuous Integration / Continuous Deployment (CI/CD) is via the .asf.yaml file mechanism, which runs Buildbot.
The svn history was not migrated and remains available.
Foundation records, including minutes of Board meetings, remain in svn, except for the index page.
Wimsy maintains the board calendar - calendar.md in SVN. At the start of each build, a setup entry in pelicanconf.yaml calls the get_calendar.sh script, which copies the calendar into content/foundation/board.
Changes to the file do not automatically trigger a build, but the file changes rarely (about once a month) and there are regular builds which pick up changes within an hour or so.
If you wish to update and test the site locally, there is a Docker build script you can use. You will also need Git, and familiarity with working in a command-line shell.
The following instructions should work for Unix and macOS, but will need adjustment for Windows.
git clone https://github.com/apache/infrastructure-pelican.cd infrastructure-pelican.docker build -t pelican-asf .. This will take a while the first time.git clone https://github.com/apache/www-site.cd www-site.touch .authtokens.docker run -it -p8000:8000 -v $PWD:/site pelican-asf. This will generate a lot of output, but will eventually stop.theme entry in pelicanconf.yaml to theme: ../theme/apache and re-runIf you make changes to the local copy of www-site, these will be automatically built, and should appear in the browser when you refresh the page.