Skip to content

Commit

Permalink
📝 Add docs outline
Browse files Browse the repository at this point in the history
  • Loading branch information
pavithraes committed Aug 10, 2023
1 parent 9f9671f commit 001ba1e
Show file tree
Hide file tree
Showing 41 changed files with 242 additions and 8 deletions.
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/community/design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Brand design assets
---

# Brand design assets
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/community/github-conventions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: GitHub conventions
---

# GitHub conventions
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/community/governance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Governance
---

# Governance
8 changes: 7 additions & 1 deletion docusaurus-docs/docs/community/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
---
description: Create a index page.
sidebar_position: 8
description: Community
---

# Community

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/community/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Release process
---

# Release process
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/community/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Support
---

# Support
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/contribute/contribute-core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Contribute to conda-store
---

# Contribute to conda-store
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/contribute/contribute-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Contribute to conda-store's documentation
---

# Contribute to conda-store's documentation
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/contribute/contribute-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Contribute to conda-store JupyterLab extension
---

# Contribute to conda-store JupyterLab extension
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/contribute/contribute-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Contribute to conda-store UI
---

# Contribute to conda-store UI
11 changes: 11 additions & 0 deletions docusaurus-docs/docs/contribute/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 7
description: Contribute
---

# Contribute

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/contribute/traige.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Triage
---

# Triage
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/explanations/environments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Environments
---

# Environments
6 changes: 6 additions & 0 deletions docusaurus-docs/docs/explanations/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 5
description: Conceptual guides
---

# Conceptual guides
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/explanations/resource-performance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Resource & Performance
---

# Resource & Performance
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: FAQ
---

# Frequently asked questions
6 changes: 6 additions & 0 deletions docusaurus-docs/docs/get-started/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
---
sidebar_position: 2
description: Create a index page.
---

# Get started

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/get-started/install-conda-store.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Install conda-store
---

# Install conda-store
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/get-started/install-extension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Install jupyterlab-conda-store
---

# Install JupyterLab extension
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/get-started/install-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Install conda-store-ui
---

# Install conda-store-ui
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/how-tos/configure-conda-store.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Configure conda-store
---

# Configure conda-store
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/how-tos/configure-ui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Configure conda-store UI
---

# Configure conda-store UI
11 changes: 11 additions & 0 deletions docusaurus-docs/docs/how-tos/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 4
description: How to guides
---

# How-to Guides

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
20 changes: 18 additions & 2 deletions docusaurus-docs/docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
---
description: Create a intro page.
sidebar_position: 1
title: Introduction
description: Introduction to documentation.
---

# Welcome!
# Welcome to conda-store's documentation

conda-store is an open source tool for managing data science environments in collaborative teams. It provides flexible, yet reproducible, environments while enforcing best practices throughout your environment's life cycle.

## Learning paths

<!-- TODO -->

## Projects

<!-- TODO: Expand with context -->

* conda-store
* conda-store-ui
* jupyterlab-conda-store
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/references/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: API docs
---

# API docs
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/references/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Glossary
---

# Glossary
6 changes: 6 additions & 0 deletions docusaurus-docs/docs/references/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
---
sidebar_position: 6
description: Create a index page.
---

# Reference

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/references/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Release notes
---

# Release notes
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/references/storybook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Storybook component docs
---

# Storybook component docs
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/tutorials/authentication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Authentication
---

# Login and Logout
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/tutorials/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Use the CLI
---

# Use the CLI
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/tutorials/create-edit-envs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Create and edit environments
---

# Create and edit environments
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/tutorials/delete-environments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Delete environments
---

# Delete environments
11 changes: 11 additions & 0 deletions docusaurus-docs/docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
sidebar_position: 3
description: Tutorials
---

# Tutorials

import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';

<DocCardList items={useCurrentSidebarCategory().items}/>
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/tutorials/request-packages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Request packages
---

# Request packages
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/tutorials/shebang.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Use shebang
---

# Use shebang
5 changes: 5 additions & 0 deletions docusaurus-docs/docs/tutorials/version-control.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: Switch environment versions
---

# Switch environment versions
5 changes: 0 additions & 5 deletions docusaurus-docs/docs/user-guide/index.md

This file was deleted.

17 changes: 17 additions & 0 deletions docusaurus-docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Layout from '@theme/Layout';
import HomepageFeatures from '@site/src/components/HomepageFeatures';
import CondaStoreLogo from '@site/static/img/logo.svg';
import useBaseUrl, {useBaseUrlUtils} from '@docusaurus/useBaseUrl';

import styles from './index.module.css';

Expand All @@ -31,6 +32,21 @@ function HomepageHeader() {
);
}

function HomepageVideo() {
const {siteConfig} = useDocusaurusContext();
return (
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<div className="container">
<img
src={useBaseUrl('/img/conda-store-ui.webp')}
className={styles.video}
/>
<br></br>
</div>
</header>
);
}

export default function Home() {
const {siteConfig} = useDocusaurusContext();
return (
Expand All @@ -40,6 +56,7 @@ export default function Home() {
<HomepageHeader />
<main>
<HomepageFeatures />
<HomepageVideo />
</main>
</Layout>
);
Expand Down
4 changes: 4 additions & 0 deletions docusaurus-docs/src/pages/index.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@
.logo {
max-width: 15%;
}

.video {
width: 80%;
}
Binary file added docusaurus-docs/static/img/conda-store-ui.webp
Binary file not shown.

0 comments on commit 001ba1e

Please sign in to comment.