apache / incubator-hugegraph-doc

HugeGraph Website and Doc
https://hugegraph.apache.org/
Apache License 2.0
66 stars 99 forks source link

[BUG] Website MUST have Incubation disclaimer on all pages #359

Closed sebbASF closed 6 months ago

sebbASF commented 6 months ago

Problem Type (问题类型)

lack info (文档描述缺失)

Your Question (问题描述)

Website MUST have Incubation disclaimer on all pages. The disclaimer is currently only on the home page as far as I can tell. That is not sufficient, all public facing documentation should include the disclaimer

dosubot[bot] commented 6 months ago

To ensure the Incubation disclaimer appears on all pages of your website, you should integrate the disclaimer into a common component, such as a footer or header, that's included on every page. Here's a quick example of how you could implement this in HTML within a footer component:

<footer>
    <p>Apache HugeGraph is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
</footer>

Make sure to include this footer in the layout template for every page. If your site is built with a framework that supports reusable components or templates, like Hugo, you can define this footer once in a partial template and include it across all pages with a simple reference in your base layout:

{{ partial "footer.html" . }}

This approach ensures the disclaimer is consistently displayed across your website, aligning with project guidelines. If there are specific workflows or approval processes for making changes to your website, ensure to follow those as outlined in your project's contribution guidelines. Additionally, leveraging automation tools like GitHub Actions for deployment can streamline updates to your website, ensuring changes are efficiently reflected live.

#### Details **Sources** - [content/en/_index.html](https://github.com/apache/incubator-hugegraph-doc/blob/master/content/en/_index.html) - [themes/docsy/assets/vendor/bootstrap/site/layouts/_default/home.html](https://github.com/apache/incubator-hugegraph-doc/blob/master/themes/docsy/assets/vendor/bootstrap/site/layouts/_default/home.html) - [themes/docsy/assets/vendor/bootstrap/site/assets/scss/_footer.scss](https://github.com/apache/incubator-hugegraph-doc/blob/master/themes/docsy/assets/vendor/bootstrap/site/assets/scss/_footer.scss) - [themes/docsy/i18n/en.toml](https://github.com/apache/incubator-hugegraph-doc/blob/master/themes/docsy/i18n/en.toml) - [themes/docsy/assets/vendor/bootstrap/site/layouts/partials/footer.html](https://github.com/apache/incubator-hugegraph-doc/blob/master/themes/docsy/assets/vendor/bootstrap/site/layouts/partials/footer.html) - [content/cn/_index.html](https://github.com/apache/incubator-hugegraph-doc/blob/master/content/cn/_index.html) - [content/en/docs/contribution-guidelines/contribute.md](https://github.com/apache/incubator-hugegraph-doc/blob/master/content/en/docs/contribution-guidelines/contribute.md) - [content/cn/docs/contribution-guidelines/contribute.md](https://github.com/apache/incubator-hugegraph-doc/blob/master/content/cn/docs/contribution-guidelines/contribute.md) - [themes/docsy/assets/vendor/bootstrap/.github/CODEOWNERS](https://github.com/apache/incubator-hugegraph-doc/blob/master/themes/docsy/assets/vendor/bootstrap/.github/CODEOWNERS) - [content/en/docs/scripts/github-deploy.sh](https://github.com/apache/incubator-hugegraph-doc/blob/master/content/en/docs/scripts/github-deploy.sh) - [.github/workflows/hugo.yml](https://github.com/apache/incubator-hugegraph-doc/blob/master/.github/workflows/hugo.yml)
**About Dosu** This response is meant to be useful and save you time. It is **not meant to be a precise solution**, but rather a starting point for your own research. Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

To continue the conversation, mention @dosu.

imbajin commented 6 months ago

Problem Type (问题类型)

lack info (文档描述缺失)

Your Question (问题描述)

Website MUST have Incubation disclaimer on all pages. The disclaimer is currently only on the home page as far as I can tell. That is not sufficient, all public facing documentation should include the disclaimer

thanks for the reminder, we'll add it soon

image

liuxiaocs7 commented 6 months ago

Hi, @sebbASF, we have add Incubation disclaimer on all pages by #360, plz take a look.