Hi all,

I'm starting a discussion about the website solution for the Hunter project.

ASF provides multiple templates for different site frameworks at 
https://github.com/apache/apache-website-template.

In the Pulsar project, we use Docusaurus [1]. I would personally prefer using 
Docusaurus for Hunter as well, unless there are other preferences.
At ASF, there is a solution that automatically publishes content from a branch 
to the website when the branch contains a `.asf.yaml` file with specific 
content matching the branch name (example [2], docs [3], source code comment 
[4]).

The ASF template for Docusaurus is in the `docusaurus` branch of the 
apache-website-template repository at 
https://github.com/apache/apache-website-template/tree/docusaurus.
One of the great features of Docusaurus is versioned documentation. Here's an 
example of Pulsar's documentation: https://pulsar.apache.org/docs/4.0.x/.

Besides the site framework, we also need to decide whether we want to keep the 
website as part of the main repository in a folder or branch, or have it in an 
independent repository. I recommend creating a separate repository for the 
website so that we don't increase the size of the main repository with 
website-related revisions. I suggest creating a repository called "hunter-site" 
for the website.

Do others have preferences for the website solution? What are your thoughts?
What kind of content would we like to have on the website? Could we reuse some 
content that has been published about Hunter in the past and repurpose it for 
the website? How do we resolve copyright matters if content is reused?

-Lari

1 - https://docusaurus.io/
2 - https://github.com/apache/pulsar-site/blob/asf-site-next/.asf.yaml
3 - https://infra.apache.org/asf-yaml.html
4 - 
https://github.com/apache/infrastructure-p6/blob/production/modules/gitbox/files/asfgit/package/asfyaml.py#L856-L863

Reply via email to