Skip to content
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

chore: Move docs to github.com/promitor/legacy-docs #2008

Merged
merged 1 commit into from
Apr 15, 2022
Merged
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
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ The promitor repository is made up of a number of different directories:
- `/config` - contains the configuration to run Promitor locally or in the CI
- `/deploy` - contains the automation that is being used to manage Promitor, such
as the automated updates concerning new Docker images in a pull request.
- `/docs` - contains the source code (mainly markdown files) for building the
<https://promitor.io>.
- `/media` - contains all media such as images and sources of schematics used in the docs
- `/media` - contains all media such as images and sources of schematics
- `/src` - contains the .NET source code for the Promitor application.

## Local Landscape
Expand All @@ -40,10 +38,12 @@ The code for Promitor's Helm chart can be found on [promitor/charts](https://git

## Documentation

The documentation for Promitor is stored in `/docs`. When adding new functionality
to Promitor or modifying existing functionality, please add associated documentation.
The documentation for Promitor is hosted on [docs.promitor.io](https://docs.promitor.io) and is maintained in [promitor/legacy-docs](https://github.com/promitor/legacy-docs).

When adding new functionality to Promitor or modifying existing functionality, please add associated documentation.

Information about how to build and run the documentation locally can be found in
the [README](docs/README.md) for the documentation.
the [contribution guide]([docs/README.md](https://github.com/promitor/legacy-docs/blob/main/CONTRIBUTING.md)) for the documentation.

Every PR will automatically build and deploy a preview version of the documentation for you.

Expand Down
2 changes: 2 additions & 0 deletions adding-a-new-scraper.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ Our testing infrastructure will pick up the new metric automatically and ensure
Features are great to have but without clear & well-written documentation they are
somewhat useless.

The documentation for Promitor is hosted on [docs.promitor.io](https://docs.promitor.io) and is maintained in [promitor/legacy-docs](https://github.com/promitor/legacy-docs).

Please provide documentation on the following:

1. What Azure service it supports and how to use it.
Expand Down
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

3 changes: 0 additions & 3 deletions docs/Gemfile

This file was deleted.

286 changes: 0 additions & 286 deletions docs/Gemfile.lock

This file was deleted.

32 changes: 0 additions & 32 deletions docs/README.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/_config.yml

This file was deleted.

Loading