Hello,

> the website solution for the Hunter project.


I do not have any preference at the moment as I haven’t worked yet with any
of the discussed options.


As Henrik mentioned above, I have been working on refactoring existing
Hunter docs into multiple pages covering different importers, exporters,
individual features, etc. My plan is to replace the “examples” folder with
“docs” containing both documentation pages in markdown as well as
reproducible examples with docker-compose. Then, either try to port these
pages to different documentation engines and see/showcase what seems to
work better or use the one we decide on in this thread.


I hope to start opening docs PRs in markdown by the end of next week, in
case we finish with setting up apache/hunter.


> What kind of content would we like to have on the website


Taking inspiration from other Apache projects:

1. Get Started - quick start, installation, concepts

2. Documentation

3. Learn - release notes, blog posts, papers, and talks

4. Community - mailing lists, Slack, Jira, How to contribute, Meet the
community.

5. Used by - list of companies and open-source projects using Hunter



>  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.


+1 for a separate repo, https://github.com/apache/hunter-website/


Best,

Alex

On Sun, Dec 8, 2024 at 12:58 PM Henrik Ingo <hen...@nyrkio.com> wrote:

> Oh, I missed a question from Lari here.
>
> On Fri, Dec 6, 2024 at 8:00 PM Lari Hotari <lhot...@apache.org> wrote:
>
> > 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.
> >
> >
> Yeah, clearly the website should be a different repo since it has nothing
> in common with the python code of Hunter.
>

Reply via email to