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

fix(docs): Test that github actions for docs complete properly on merge to main. #132

Merged
merged 63 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
63 commits
Select commit Hold shift + click to select a range
d6affe2
refactor(gateway): Rename catalyst-voices-backend to the catalyst-gat…
stevenj Oct 18, 2023
d1736b9
docs(gateway): Update readme
stevenj Oct 18, 2023
d966461
refactor(gateway): Move the code into the new directory trees, cleanu…
stevenj Oct 18, 2023
dd7594a
refactor(gateway): Basic refactor of the event-db config/data and the…
stevenj Oct 18, 2023
e00cc4e
docs(gateway): Initial docs for the crates directory inside catalyst …
stevenj Oct 18, 2023
ffc2514
refactor(gateway): Move code out of cat-data-service and put it direc…
stevenj Oct 18, 2023
fc63b2f
feat(gateway): first build seems to work, but fails due to WIP refactor
stevenj Oct 19, 2023
85f369d
refactor(gateway): Refactor builds properly to a static executable.
stevenj Oct 19, 2023
0a0ce4f
refactor(gateway): autofixed lints
stevenj Oct 19, 2023
4163ad4
refactor(gateway): WIP remove lint errors
stevenj Oct 19, 2023
ff9ed9d
refactor(gateway): WIP refactoring work to remove lint errors
stevenj Oct 20, 2023
117d1ae
refactor(gateway): Don't panic, return the error, and generalize the …
stevenj Oct 20, 2023
f07a4d5
refactor(gateway): generalize error response
stevenj Oct 20, 2023
8e398ab
docs(gateway): indexing ok here, slice already checked to have values
stevenj Oct 20, 2023
ab19189
refactor(gateway): Indexing is safe here, so note it.
stevenj Oct 20, 2023
90020db
refactor(gateway): don't panic, return an error. reduce size of func…
stevenj Oct 20, 2023
deff8a1
refactor(gateway): Purge metrics from legacy service. Unused and can…
stevenj Oct 20, 2023
d783069
refactor(gateway): remove unused rust files from EventDB directory
stevenj Oct 20, 2023
1d11b40
refactor(gateway): remove unused dependencies
stevenj Oct 20, 2023
6b0ec08
docs(gateway): Allow intentional panic for test code
stevenj Oct 20, 2023
8807d41
refactor(gateway): eliminate or notate why unwraps/expect are safe
stevenj Oct 20, 2023
df7b034
refactor(gateway): All lints are clean and restrictively applied
stevenj Oct 20, 2023
b2059af
refactor(gateway): remove unused dependencies from workspace cargo file
stevenj Oct 20, 2023
3026cda
refactor(gateway): restrict visibility of event_db to pub(crate) as i…
stevenj Oct 20, 2023
4bd314b
docs(gateway): root level fully documented
stevenj Oct 20, 2023
d044759
docs(gateway): state fully documented
stevenj Oct 20, 2023
d460fc6
docs(gateway): Don't worry about full docs for legacy service.
stevenj Oct 20, 2023
32403db
docs(gateway): Service top level fully documented
stevenj Oct 20, 2023
21652a4
docs(gateway): middleware docs complete
stevenj Oct 20, 2023
399dca9
docs(gateway): Fully documented the docs part of the service
stevenj Oct 20, 2023
34ad5a9
docs(gateway): common responses and module root fully documented
stevenj Oct 20, 2023
d195417
docs(gateway): Common objects now fully documented
stevenj Oct 20, 2023
e7c7571
docs(gateway): Api endpoint docs are complete
stevenj Oct 20, 2023
bb9a680
docs(gateway): DB Types fully documented
stevenj Oct 20, 2023
1dd5df6
docs(gateway): Queries partially documented
stevenj Oct 20, 2023
791dc90
docs(gateway): Everything that needs docs is documented
stevenj Oct 20, 2023
eb2d73f
feat(gateway): Initial CI and Cat-Gateway build ready for PR
stevenj Oct 20, 2023
1a982e9
feat(rust): Add recommended rust extensions for vscode, and rust sett…
stevenj Oct 20, 2023
2554ca3
docs(gateway): Fix spelling
stevenj Oct 20, 2023
906d5eb
ci(gateway): Use the proper versioned CI tooling from catalyst-ci
stevenj Oct 24, 2023
34750c3
Merge branch 'main' into feat/catalyst-gateway
stevenj Oct 24, 2023
98f2e4a
feat(docs): Docs WIP setup
stevenj Oct 26, 2023
b1eb247
docs(docs): Fix the docs so they use the latests docs-ci and are able…
stevenj Nov 2, 2023
f43fe65
docs(docs): fix spelling and markdown lint issues
stevenj Nov 2, 2023
08cc557
docs(docs): Update to use latest Cat-CI Docs and reduce replication
stevenj Nov 3, 2023
752571b
docs(docs): Fix the top level parts of the docs and remove test values
stevenj Nov 3, 2023
53d5e29
Merge branch 'main' into feat/voices-docs
stevenj Nov 3, 2023
65fdbf1
docs(docs): try and build and deploy docs to gh-pages
stevenj Nov 4, 2023
6c82887
docs(docs): fix spelling issue
stevenj Nov 4, 2023
a495586
docs(docs): Use proper docs action, and also add branch cleanup for b…
stevenj Nov 4, 2023
46f3418
Merge branch 'main' into feat/voices-docs
stevenj Nov 6, 2023
3e87a84
docs(docs): Use the published versions from Catalyst-CI
stevenj Nov 8, 2023
4ec5afa
docs(docs): Ensure we do not try and clean docs while building them.
stevenj Nov 8, 2023
ac80bd1
docs(docs): Ensure we don't try and build docs simultaneously, Don't …
stevenj Nov 8, 2023
b456f33
ci(mdlint): Use tagged CI versions for stability
stevenj Nov 8, 2023
086b7ab
ci(spelling): Use tagged CI versions for stability
stevenj Nov 8, 2023
adb7605
docs(docs): Edit docs so we test deployment
stevenj Nov 8, 2023
98840cb
Merge branch 'main' into feat/voices-docs
stevenj Nov 8, 2023
ff1f34d
fix(docs): Try and force docs to build for all branches, but not for …
stevenj Nov 8, 2023
66a0aa5
fix(docs): Revert docs to build on any push and see if they start bui…
stevenj Nov 8, 2023
9be9c11
fix(docs): Use latest workflow from catalyst-ci for docs
stevenj Nov 8, 2023
c09a7b0
fix(docs): Docs should build for any branch but never for a tag.
stevenj Nov 8, 2023
2f532d2
fix(docs): Need double quotes for branches to work properly
stevenj Nov 8, 2023
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
6 changes: 4 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ name: Docs

on:
push:
branches:
- "**"
tags-ignore:
- "*"
- "**"

concurrency:
group: "docs"
Expand All @@ -18,7 +20,7 @@ permissions:

jobs:
ci:
uses: input-output-hk/catalyst-ci/.github/workflows/pages.yml@v2.0.6
uses: input-output-hk/catalyst-ci/.github/workflows/pages.yml@master
with:
aws_role_arn: arn:aws:iam::332405224602:role/ci
aws_region: eu-central-1
Expand Down
2 changes: 2 additions & 0 deletions docs/src/monorepo-architecture/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ icon: material/pencil-ruler

<!-- markdownlint-disable MD025-->
# Monorepo Architecture

TODO, add description and diagram of Monorepo architecture.