www.apache.org)
Apache Foundation Website (We are now in production
This repository provides the source for the main website of The Apache Software Foundation.
-
- md pages in GitHub Flavored Markdown which can include HTML.
- ezmd pages in a combination of ezt and GitHub Flavored Markdown.
- html files are treated as static files.
- static assets of all types.
- .htaccess files for redirection and rewrite rules.
-
Branches. Note that .asf.yaml is setup for autopreview, so that a branch named
preview/mytest
for example is automatically staged at https://www-mytest.staged.apache.org/
Linking to Markdown (.md) sources
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:
- link to the rendered file as normal, for example: https://github.com/apache/www-site/blob/main/README.md
- append ?plain=1 to the URL, for example: https://github.com/apache/www-site/blob/main/README.md?plain=1
- the file displays with line numbers, as for other types of files. Click a line number to generate a permalink or create an issue with a link to the line
Documentation
Read the Getting started guide and the pages it links to.
Notes
The website is built with Pelican.
The infrastructure-pelican Dockerfile can be used to build the website locally, for testing.
Continuous Integration / Continuous Deployment (CI/CD) is via the .asf.yaml file mechanism which runs Buildbot.
- Pelican Configuration -- pelican configuration
- ASF Data Load -- ASF metadata to be used by ezt and pelican. See asfdata.py.
- ASF YAML Pelican Build -- ASF infrastructure instructions
The svn history was not migrated and remains available.
Foundation records, including minutes of Board meetings, remain in svn, except for the index page.