Skip to content

Commit

Permalink
Merge pull request clearlydefined#99 from clearlydefined/move-docs
Browse files Browse the repository at this point in the history
Infrastucture docs have moved
  • Loading branch information
ljones140 authored Dec 17, 2024
2 parents a1cc2f5 + 6988c99 commit 223409b
Show file tree
Hide file tree
Showing 9 changed files with 589 additions and 1,081 deletions.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,40 @@
# Operational home for ClearlyDefined

This repo is dedicated to operational concerns for ClearlyDefined, including the layout on Azure and DevOps implications.

Some high level subpages exist:
* [Thorough Infrastucture Overview](./overview.md)
* [Crawler Contacts](./crawler-contacts.md)
* [ClearlyDefined's identities in other systems](./clearly-defined-identities.md)
* [Cloud resources](./cloud-resources.md)
* [Alerts](./alerts.md)
This repo is dedicated to operational concerns for ClearlyDefined

## Consumer resources
| Resource | dev | prod |
| -- | -- | --
| Webpage | [Link](https://dev.clearlydefined.io) | [Link](https://clearlydefined.io) |
| Webpage | [Link](https://dev.clearlydefined.io) | [Link](https://clearlydefined.io) |
| Docpage | N/A | [Link](https://docs.clearlydefined.io/) |
| API | [Link](https://dev-api.clearlydefined.io/) | [Link](https://api.clearlydefined.io/)
| API Swagger | [Link](https://dev-api.clearlydefined.io/api-docs/) | [Link](https://api.clearlydefined.io/api-docs/)

## Contributor resources
[GitHub Org](https://github.com/clearlydefined)
[GitHub Org](https://github.com/clearlydefined)

Contact info:
Contact info:
* [Discord](https://discord.gg/wEzHJku)
* [Mailing List / Discussion Group](https://groups.google.com/forum/#!forum/clearlydefined)
* [Operations / Alerts Group](https://groups.google.com/forum/#!forum/clearlydefinedsupport) -- Invite only, login as clearlyddefined and invite yourself (or get someone else to invite you)

### Repos
[Service](https://github.com/clearlydefined/service)
[Website](https://github.com/clearlydefined/website)
[Crawler](https://github.com/clearlydefined/crawler)
[Operations](https://github.com/clearlydefined/operations)
### Services

Service AKA API:
- [Repo](https://github.com/clearlydefined/service)
- [Configuration Guide](service_config/service.md)

Website:
- [Repo](https://github.com/clearlydefined/website)
- [Configuration Guide](service_config/website.md)

Crawler:
- [Crawler](https://github.com/clearlydefined/crawler)
- [Configuration Guide](service_config/crawler.md)

## Infrastructure

For details on how ClearlyDefined services are deployed see private repo
https://github.com/clearlydefined/infrastructure

### Build / Deployment
[Azure DevOps builds](https://dev.azure.com/clearlydefined/ClearlyDefined/_build)
Runbooks for specific operations [here](https://github.com/clearlydefined/infrastructure/runbooks)
17 changes: 0 additions & 17 deletions alerts.md

This file was deleted.

8 changes: 0 additions & 8 deletions clearly-defined-identities.md

This file was deleted.

46 changes: 0 additions & 46 deletions cloud-resources.md

This file was deleted.

23 changes: 0 additions & 23 deletions crawler-contacts.md

This file was deleted.

Loading

0 comments on commit 223409b

Please sign in to comment.