Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,9 @@ node_modules

# Ignore manual test scripts
manual_tests/

# Design working files (local only — back up to opentdf/brand-assets)
design/

# Claude instructions (local only)
CLAUDE.md
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Contributing
# Contributing to opentdf/docs

The information below is meant for documentation contributors.
Thank you for contributing to OpenTDF documentation! For general contribution
guidelines, community feedback channels, and branch/commit conventions, see
[platform/CONTRIBUTING.md](https://github.com/opentdf/platform/blob/main/CONTRIBUTING.md).

The information below is specific to documentation contributions.


## Prerequisites
Expand Down
6 changes: 6 additions & 0 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,11 @@ Find all the information you need to get started with OpenTDF.
"Learn about the OpenTDF CLI tool (otdfctl) and how it can be used to manage the OpenTDF platform.",
url: "/components/cli",
},
{
name: "Contributing",
description:
"Report bugs, request features, ask questions, or contribute code and docs. All community activity is welcome.",
url: "https://github.com/opentdf/platform/blob/main/CONTRIBUTING.md",
},
]}
/>
98 changes: 47 additions & 51 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ const config: Config = {
"@type": "Organization",
name: "OpenTDF",
url: "https://opentdf.io",
logo: "https://docs.opentdf.io/img/opentdf-social.png",
logo: "https://opentdf.io/img/opentdf-icon.svg",
}),
},
],
Expand Down Expand Up @@ -92,7 +92,7 @@ const config: Config = {
},
blog: false,
theme: {
customCss: "./src/css/custom.css",
customCss: ["./src/css/custom.css", "./src/css/landing.css"],
},
},
],
Expand All @@ -111,6 +111,7 @@ const config: Config = {
logo: {
alt: "OpenTDF - Protect the Data, Build the Future",
src: "img/OpenTDF-Logo.png",
srcDark: "img/OpenTDF-Logo-White.png",
width: 32,
height: 32,
},
Expand All @@ -122,84 +123,79 @@ const config: Config = {
label: "Docs",
},
{
href: "https://github.com/opentdf",
label: "GitHub",
position: "right",
to: "/quickstart",
position: "left",
label: "Quickstart",
},
{
type: "search",
to: "/sdks",
position: "left",
label: "SDKs",
},
{
to: "/spec",
position: "left",
label: "Specification",
},
{
href: "https://github.com/orgs/opentdf/discussions",
position: "left",
label: "Community",
},
{
href: "https://github.com/opentdf",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
logo: {
alt: "OpenTDF Logo",
src: "img/opentdf-logo-horizontal.png",
href: "https://opentdf.io",
},
links: [
{
title: "Sponsors",
title: "Project",
items: [
{
label: "Virtru",
href: "https://virtru.com",
},
{ label: "About", to: "/introduction" },
{ label: "Architecture", to: "/architecture" },
{ label: "Specification", to: "/spec" },
{ label: "License", href: "https://github.com/opentdf/platform/blob/main/LICENSE" },
],
},
{
title: "Support",
title: "Developers",
items: [
{
label: "Getting Started",
to: "/getting-started/configuration",
},
{
label: "Documentation",
to: "/introduction",
},
{
label: "GitHub Discussions",
href: "https://github.com/orgs/opentdf/discussions",
},
{ label: "Quickstart", to: "/quickstart" },
{ label: "SDKs", to: "/sdks" },
{ label: "Platform", href: "https://github.com/opentdf/platform" },
{ label: "CLI Reference", href: "https://github.com/opentdf/otdfctl" },
],
},
{
title: "More",
title: "Community",
items: [
{
label: "Showcase",
href: "https://github.com/orgs/opentdf/discussions/categories/show-and-tell",
},
{
label: "Roadmap",
href: "https://opentdf.io/appendix/matrix",
},
{ label: "GitHub", href: "https://github.com/opentdf" },
{ label: "Discussions", href: "https://github.com/orgs/opentdf/discussions" },
{ label: "Contributing", href: "https://github.com/opentdf/platform/blob/main/CONTRIBUTING.md" },
{ label: "Code of Conduct", href: "https://github.com/opentdf/platform/blob/main/CODE_OF_CONDUCT.md" },
],
},
{
title: "Legal",
title: "Sponsor",
items: [
{
label: "Privacy Policy",
to: "/privacy-policy",
},
{
label: "Cookie Policy",
to: "/cookie-policy",
},
{
label: "Terms of Service",
to: "/terms-of-service",
html: `<p class="footer__sponsor-text">OpenTDF is sponsored and maintained by <a href="https://www.virtru.com" target="_blank" rel="noopener noreferrer">Virtru</a>, building data-centric security solutions since 2012.</p>`,
},
],
},
],
copyright: `
<span>Copyright © ${new Date().getFullYear()} OpenTDF</span>
<iconify-icon data-icon="mdi:shield-check" style="color: #00FF00;"></iconify-icon>
<div>
<span>Copyright © ${new Date().getFullYear()} OpenTDF</span>
</div>
<div class="footer__license-info">
Documentation licensed under <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="noopener noreferrer">CC BY 4.0</a> •
Code licensed under <a href="https://github.com/opentdf/platform/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">BSD 3-Clause</a>
</div>
`,
},
prism: {
Expand Down
Loading