Skip to content

Commit

Permalink
Add documentation for Red Hatters
Browse files Browse the repository at this point in the history
  • Loading branch information
alechenninger committed Apr 17, 2024
1 parent b078a32 commit 9822cac
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 72 deletions.
32 changes: 19 additions & 13 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,31 +1,37 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
import tailwind from '@astrojs/tailwind';
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import tailwind from "@astrojs/tailwind";

// https://astro.build/config
export default defineConfig({
site: 'https://project-kessel.github.io',
base: 'docs',
site: "https://project-kessel.github.io",
base: "docs",
integrations: [
starlight({
title: 'Docs with Tailwind',
title: "Kessel",
social: {
github: 'https://github.com/withastro/starlight',
github: "https://github.com/project-kessel",
},
sidebar: [
{
label: 'Guides',
label: "Start Here",
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Example Guide', link: '/guides/example/' },
{ label: "Coming Soon", link: "./start-here/coming-soon/" },
],
},
{
label: 'Reference',
autogenerate: { directory: 'reference' },
label: "For Red Hatters",
link: "./for-red-hatters/",
attrs: {
class: "red-hat",
},
},
{
label: "Reference",
autogenerate: { directory: "reference" },
},
],
customCss: ['./src/tailwind.css'],
customCss: ["./src/tailwind.css", "./src/custom.css"],
}),
tailwind({ applyBaseStyles: false }),
],
Expand Down
1 change: 1 addition & 0 deletions src/assets/redhat.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions src/content/docs/for-red-hatters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: For Red Hatters
description: Information for Red Hatters about using Kessel.
---

Kessel is an open source project also deployed internally. To learn more about leveraging Kessel
internally please see one of these documentation mirrors based on preferred auth method:

- GitHub auth: https://project-kessel.github.io/docs-internal
- VPN auth: https://project-kessel.pages.redhat.com/docs-internal
11 changes: 0 additions & 11 deletions src/content/docs/guides/example.md

This file was deleted.

46 changes: 9 additions & 37 deletions src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,46 +1,18 @@
---
title: Welcome to Starlight
title: Kessel Documentation
description: Get started building your docs site with Starlight.
template: splash
hero:
title: |
Welcome to Starlight with
<span
class="font-black text-transparent
bg-clip-text bg-gradient-to-b
from-accent-700 to-accent-400
dark:from-accent-500 dark:to-accent-200"
>
Tailwind
</span>
tagline: Congrats on setting up a new Starlight project!
image:
file: ../../assets/houston.webp
Kessel
tagline: Open source, multi-app, B2B access and policy management.
actions:
- text: Example Guide
link: ./guides/example/
- text: For Red Hatters

link: ./for-red-hatters/
icon: right-arrow
variant: primary
- text: Read the Starlight docs
link: https://starlight.astro.build
icon: external
- text: More coming soon!
link: ./start-here/coming-soon/
variant: secondary
---

import { Card, CardGrid } from '@astrojs/starlight/components';

## Next steps

<CardGrid stagger>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
</Card>
</CardGrid>
11 changes: 0 additions & 11 deletions src/content/docs/reference/example.md

This file was deleted.

6 changes: 6 additions & 0 deletions src/content/docs/start-here/coming-soon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Coming soon
description: Coming soon
---

Coming soon.
16 changes: 16 additions & 0 deletions src/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* Use custom css only in exceptional circumstances.
* Like adding cute hats where it is otherwise not possible.
*/

.red-hat::after {
content: "";
display: inline-block;
width: 24px;
height: 24px;
background-image: url('assets/redhat.svg');
background-size: contain;
background-repeat: no-repeat;;
margin-left: 5px;
vertical-align: middle;
}

0 comments on commit 9822cac

Please sign in to comment.