Skip to content

Commit

Permalink
Merge pull request #3647 from sandstorm-io/docs-delete-graphviz
Browse files Browse the repository at this point in the history
Docs: delete graphviz
  • Loading branch information
ocdtrekkie authored Jul 31, 2022
2 parents 46fdb75 + d9b167c commit bf47ef3
Show file tree
Hide file tree
Showing 7 changed files with 161 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/doc-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: install dependencies
run: |
sudo apt-get update
sudo apt-get install -y git virtualenv graphviz
sudo apt-get install -y git virtualenv
virtualenv tmp/docs-virtualenv
tmp/docs-virtualenv/bin/pip install -r docs/requirements.txt
- name: build docs
Expand Down
2 changes: 1 addition & 1 deletion docs/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ my_git() {
assert_dependencies() {
if [ "${DO_SETUP}" == "yes" ] ; then
if ! (which dot && which virtualenv); then
sudo apt-get install -y git virtualenv graphviz
sudo apt-get install -y git virtualenv
fi
if [ ! -e "$OUTPUT_DIR/.git" ] ; then
my_git clone --branch gw-pages --depth 1 "$SANDSTORM_DOC_URL" "$OUTPUT_DIR"
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
jinja2==3.0.3
markdown==3.3.7
mkdocs==1.0.4
mkdocs-markdown-graphviz==1.3
79 changes: 79 additions & 0 deletions docs/using/communication_overview_http_app.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions docs/using/communication_overview_native_app.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 12 additions & 4 deletions docs/using/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,12 @@ and the grain occur over the Cap'n Proto WebSession format. With existing
applications, the Sandstorm HTTP bridge is used to translate between Cap'n
Proto and HTTP.

```graphviz dot communication_overview_http_app.svg
![Diagram with HTTP Bridge](communication_overview_http_app.svg)

<!--
NOTE: Included SVGs on this page were created in Graphviz DOT language, and are provided here for convenience in regenerating the files if needed.
graphviz dot communication_overview_http_app.svg
graph communication_overview_http_app {
rankdir=LR;
compound=true;
Expand All @@ -47,12 +52,15 @@ Proto and HTTP.
websession -- bridge;
bridge -- app;
}
```
-->

When an application can speak Cap'n Proto directly to Sandstorm, the HTTP
bridge is not needed.

```graphviz dot communication_overview_native_app.svg
![Diagram without HTTP Bridge](communication_overview_native_app.svg)

<!--
graphviz dot communication_overview_native_app.svg
graph communication_overview_native_app {
rankdir=LR;
compound=true;
Expand All @@ -75,4 +83,4 @@ bridge is not needed.
proxy -- websession;
websession -- app;
}
```
-->
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ theme:
repo_url: https://github.com/sandstorm-io/sandstorm
edit_uri: edit/master/docs/
markdown_extensions:
- mkdocs_markdown_graphviz
- admonition
extra_css:
- "extra.css"
Expand Down

0 comments on commit bf47ef3

Please sign in to comment.