Skip to content

docs(NODE-3363): added docs for proposed error hierarchy #2862

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 24 commits into from
Jul 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
1a39b0d
test: Test to ensure GridFSWriteStream#destroy (#2703)
durran Jan 20, 2021
4967d35
docs(NODE-3363): redesign error hierarchy
andymina Jun 24, 2021
eb86b5a
docs: started writing up errors docs
W-A-James Jun 24, 2021
b19908d
docs(NODE-3363): added hierarchy charts
andymina Jun 25, 2021
06a67ba
docs(NODE-3363): formatted markdown to include nesting
andymina Jun 25, 2021
5ee6608
chore(NODE-3363): reorganized mermaid structure in `docs/`
andymina Jun 25, 2021
cde99e0
docs(NODE-3363): relinked imgs to `errors.md`
andymina Jun 25, 2021
360fce6
docs(NODE-3363): designing test plan
andymina Jun 25, 2021
7e0b6f0
docs: Fix spelling errors and update diagrams(wip)
W-A-James Jun 25, 2021
e5bedf8
docs(NODE-3363): added classes to test to test plan
andymina Jun 25, 2021
0d990cc
docs: Break diagram down into 3 parts
W-A-James Jun 25, 2021
2dddb06
docs(NODE-3363): reformatted table of contents and test plan
andymina Jun 25, 2021
7562557
docs(NODE-3363): filled out the test plan
andymina Jun 25, 2021
aa8d15b
chore: remove extra diagram file
W-A-James Jun 25, 2021
4548d76
docs: Add MongoInvalidClassInstantiationError
W-A-James Jun 25, 2021
642fc59
docs: Updates to diagrams
W-A-James Jun 25, 2021
1f6477e
docs(NODE-3363): resized headings in the test plan
andymina Jun 25, 2021
22c9463
chore: Ensure sentences are on separate lines for ease of review
W-A-James Jun 28, 2021
7bc91b1
fix: revise charts
W-A-James Jun 28, 2021
4793cba
docs: Added documentation on mermaid diagrams
W-A-James Jun 28, 2021
509d445
chore: Made build_images.sh build svgs in parallel
W-A-James Jun 30, 2021
9ed8ffd
docs: Update mermaid files and svgs
W-A-James Jun 30, 2021
1cd2f6e
docs(NODE-3363): synced charts with markdown
andymina Jul 1, 2021
0d69383
docs(NODE-3363): updated charts to match markdown
andymina Jul 6, 2021
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
7 changes: 7 additions & 0 deletions docs/charts/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Charts and mermaid code

The `mermaid` directory contains the [mermaid](https://mermaid-js.github.io/mermaid/#/) files which serve as the source code for the svg files included in the `../errors.md`

To generate these files, there is an included script, `build_images.sh` which builds images for all the mermaid files in the `mermaid` directory.

To use this script, the [mermaid cli](https://github.com/mermaid-js/mermaid-cli) must be installed and be accessible via your $PATH variable.
13 changes: 13 additions & 0 deletions docs/charts/build_images.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#! /bin/bash

echo "Building svgs..."
cd mermaid
for f in *.mmd
do
echo "Processing $f"
outname="${f%%.*}"
mmdc -i $f -o ../imgs/$outname.svg &
done
wait

echo "Done"
4 changes: 4 additions & 0 deletions docs/charts/imgs/MongoAPIError.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading