Skip to content

Update readme #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 8, 2023
Merged
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
97 changes: 19 additions & 78 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# Documentation
# ValidMind

The home for our user-facing documentation and related infrastructure. If you need to make updates to our external docs site, you're in the right place.
![](site/guide/ValidMind-logo-color.svg)

This is the home for the user-facing documentation and related infrastructure for ValidMind. If you want to make updates to our external docs site, you're in the right place.

## Contributing to the documentation

We believe in the power of collaboration and welcome contributions from the community. If you've noticed an issue or have ideas for improvement, please create a pull request or submit an issue. A member of ValidMind's documentation team will review your suggestions and support you in contributing to the docs.

- Follow the [Quickstart](https://docs.validmind.ai/guide/quickstart.html) for a 20 minute introduction to the Developer Framework and ValidMind Platform.

- Read the [Developer Framework docs](https://docs.validmind.ai/guide/developer-framework.html) for more information about ValidMind's open source tests and Jupyter notebooks.

- Join the [Community Slack](site/guide/join-community.qmd) to ask questions, get support, and connect with Model Risk Management (MRM) practioners.

## Prerequisites

Expand All @@ -11,34 +23,11 @@ You need:
- [Quarto CLI](https://quarto.org/docs/get-started/)
- The Quarto extension for your IDE, such as [VS Code](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)

## How our docs site is sourced

```bash
site
├── _source
| └── validmind-python
| └── docs
| └── _build
| └── validmind
| └── *.html, *.js
├── guide
│ └── *.qmd, *.svg, *.png
├── notebooks
| ├── how_to
| | └── *.ipynb
│ └── *.ipynb
├── _quarto.yml
└── index.qmd
```
**_source/ ... validmind/** — Built Developer Framework API docs

**guide/** — Core docs sourced in Quarto Markdown
## How to contribute

**notebooks/** — Jyupiter notebooks copied from [validmind-python/notebooks](https://github.com/validmind/validmind-python/tree/main/notebooks) or Google Drive
Our core docs are sourced in Quarto Markdown under [site/guide/](https://github.com/validmind/documentation/tree/main/site/guide). If you create new documentation, make sure to add it to the [_quarto.yml](https://github.com/validmind/documentation/blob/main/site/_quarto.yml) file.

**_quarto.yml** — Rendering options for the site, including navigation, search, footer, and more

**index.qmd** — Main landing page sourced in Quarto Markdown and HTML
If you are creating a pull request, test your changes by rendering or previewing the site. Note that if this is your first time contributing, you will be asked to sign a contributor license agreement (CLA).

## Preview the docs site

Expand All @@ -47,23 +36,7 @@ cd site
quarto preview
```

## Update files sourced from other repos

```bash
cd site
make get-source
```

Important: This action doesn't copy the Jupyter notebooks sourced from [Google Drive](https://drive.google.com/drive/folders/1o2TcY9PM-OkjBKdfenymuaeAIqarY4T2). You need to update these notebooks _manually_.

## Generate the docs site

Including fetching the source from other repos:

```bash
cd site
make docs-site
```
## Render the docs site

Just render the site:

Expand All @@ -78,36 +51,4 @@ The rendered static HTML output lives in:
site
└── _site ...
└── *.html, *.css, *.png, *.js ...
```

## Deploy the production docs site

Automatically from the `prod` branch: merge a commit into the branch with the latest changes from `main`.

Manually from the `main` or `prod` branches:

```bash
make deploy-prod
```

## Deploy the docs demo site

Automatically from the `docs-demo` branch: merge a commit into the branch, e.g. with the files you want to deploy.

Manually from the `docs-demo` branch:

```bash
make deploy-demo
```

## Generate release notes

From the tag for the upcoming release, click 'Create release from tag', and then 'Generate release notes' to generate a list of pull requests to include in the upcoming release. Do this in the documentation, validmind-python, and frontend repos.

From the documentation repo:

```bash
cd site
make release-notes
```
Enter the release tag for each repo, and the date for the upcoming release.
```