Update docs to use docker image #6437
Conversation
tephenavies
force-pushed
the
docker-docs
branch
from
40ca44c to
08d90da
Compare
This commit is a pre-prettier commit
This is a post-prettier commit
|
Update 15 Feb 2023:
|
You can now use gulp render-guide to avoid rebuilding terriajs when working on docs.
| - [Getting Started](getting-started.md): Quick start guide to building your first TerriaJS application. | ||
| - [Customizing](customizing/README.md): Configure and tweak a TerriaJS application, including skinning and setting up the catalog. | ||
| - [Connecting to Data](connecting-to-data/README.md): Connect TerriaJS to your servers and data. | ||
| - [Deploying](deploying/README.md): Deploy a TerriaJS application in simple and advanced scenarios. | ||
| - [Contributing](contributing/README.md): Add new features to TerriaJS, be part of the TerriaJS development team, set up a development environment, write tests, and perform code reviews. |
There was a problem hiding this comment.
Prettier reformats lists with extra spaces after bullets when using indent_size=4. It's a little ugly, but indent_size=4 is needed for mkdocs, and it's still better to use Prettier than to have to enforce indent_size=4 manually.
There was a problem hiding this comment.
New doc file (basically the old getting started)
doc/deploying/README.md
Outdated
There was a problem hiding this comment.
Reworded this one a bit to point to Docker & Kubernetes
doc/deploying/deploying-terriamap.md
Outdated
There was a problem hiding this comment.
Moved pm2 instructions to 1 subsection
doc/deploying/deploying-to-aws.md
Outdated
There was a problem hiding this comment.
Remove old aws deploy docs
There was a problem hiding this comment.
Major simplification now that helm 3 and easier to use docker tooling (Docker Desktop & Rancher Desktop) exist.
doc/getting-started.md
Outdated
There was a problem hiding this comment.
Getting started overhaul based on Docker. Much of the previous content was moved to customizing/cloning-and-building.md.
doc/js/rewrite-links.js
Outdated
There was a problem hiding this comment.
This new link rewriter allows us to put links to code in our docs
gulpfile.js
Outdated
There was a problem hiding this comment.
Refactor tasks to allow running the quick doc generation stuff (CatalogMember page generation & mkdocs) without re-running build-for-doc-generation, which takes ages with Babel.
from:
[17:31:00] ├─┬ docs
[17:31:00] │ └─┬ <series>
[17:31:00] │ ├─┬ user-guide
[17:31:00] │ │ └─┬ <series>
[17:31:00] │ │ ├─┬ <parallel>
[17:31:00] │ │ │ ├── code-attribution
[17:31:00] │ │ │ └── build-for-doc-generation
[17:31:00] │ │ └── userGuide < Couldn't be run separately
[17:31:00] │ └── docs
to:
[17:26:15] ├─┬ docs
[17:26:15] │ └─┬ <series>
[17:26:15] │ ├─┬ <parallel>
[17:26:15] │ │ ├── code-attribution
[17:26:15] │ │ └── build-for-doc-generation
[17:26:15] │ ├─┬ render-guide < This is now its own task
[17:26:15] │ │ └─┬ <series>
[17:26:15] │ │ ├── copyToBuild
[17:26:15] │ │ ├── generateMemberPages
[17:26:15] │ │ └── mkdocs
[17:26:15] │ └── docs
There was a problem hiding this comment.
Couple of translation string improvements. These should probably have been a separate PR.
| ```ts | ||
| async function forceLoadX() { | ||
| const url = this.someObservableUrl; | ||
| const someData = await loadText(url); | ||
| runInAction(() => (this.someOtherObservable = someData)); | ||
| const url = this.someObservableUrl; | ||
| const someData = await loadText(url); | ||
| runInAction(() => (this.someOtherObservable = someData)); | ||
| } | ||
| ``` |
There was a problem hiding this comment.
indent_size=4 is even worse for code blocks in md files, but there's no prettier or editorconfig configuration that would fix this, and using 2 spaces would require patching mkdocs as the author of the parser used believes that lists in lists must be indented by 4 spaces exactly to be valid markdown.
|
UPDATE 21 June 2023: Pete should be able to finish today after meeting |
This PR is a major update of getting started and deployment docs for docs.terria.io. Docs now emphasise using docker image & Kubernetes. Preview at https://docker-docs--terriajs-docs-v8.netlify.app/guide/
Test against TerriaJS/TerriaMap#644