Skip to content

Commit

Permalink
Add startup docs to website (#496)
Browse files Browse the repository at this point in the history
* Add email form to website

* Add new items to homepage

* Add "Try it out" guide

* Move CLI docs into admin section

* Start docker compose docs

* Several typo fixes an improvements

* Add more docker and login docs

* Fix broken links

* Have demo link open small local GFF3

* Edit how to add evidence tracks jbrowse; Edit header (#495)

Do not cd to `jbrowse_data` otherwise you get:

```
apollo jbrowse get-config
    Error: Configuration file "/root/.config/apollo-cli/config.yml" does not
    exist. Please run "apollo config" first
```

Write config.json to `data/` so docker can see it otherwise you get:

```
apollo jbrowse set-config config.json
 ›   Error: File config.json does not exist
```

---

Docs header merged to be more consistent with text.

* Add images to quick-start annotation guide (#494)

* Start adding images

* Increase figure size

* Add further images

* Use markdown images for Docusaurus

---------

Co-authored-by: Garrett Stevens <[email protected]>

* Remove ROOT_USER_NAME from docs

* Add contact page

* Add blog post

* Typo; add note about using CLI

* Fix config; use latest Apollo and JBrowse versions

* Clarify deployment example docs

* More updates to docker compose deployment

* Fix env file typo

---------

Co-authored-by: Dario Beraldi <[email protected]>
  • Loading branch information
garrettjstevens and dariober authored Dec 18, 2024
1 parent 2fd0f84 commit 8b304a3
Show file tree
Hide file tree
Showing 92 changed files with 1,829 additions and 2,007 deletions.
4 changes: 2 additions & 2 deletions .husky/pre-commit.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ function main() {
'readme',
'--multi',
'--dir',
'../website/docs/cli/',
'../website/docs/admin/cli/',
],
{ stdio: 'inherit' },
)
Expand All @@ -49,7 +49,7 @@ function main() {
[
'add',
'packages/apollo-cli/README.md',
'packages/website/docs/cli/*.md',
'packages/website/docs/admin/cli/*.md',
],
{ stdio: 'inherit' },
)
Expand Down
19 changes: 0 additions & 19 deletions docker/.development.env

This file was deleted.

44 changes: 0 additions & 44 deletions docker/config/config.json

This file was deleted.

1 change: 0 additions & 1 deletion docker/google-client-id

This file was deleted.

1 change: 0 additions & 1 deletion docker/google-client-secret

This file was deleted.

1 change: 0 additions & 1 deletion docker/jwt-secret

This file was deleted.

1 change: 0 additions & 1 deletion docker/microsoft-client-id

This file was deleted.

1 change: 0 additions & 1 deletion docker/microsoft-client-secret

This file was deleted.

1 change: 0 additions & 1 deletion docker/mongodb-uri

This file was deleted.

1 change: 0 additions & 1 deletion docker/session-secret

This file was deleted.

29 changes: 0 additions & 29 deletions docs/automated_setup.md

This file was deleted.

63 changes: 0 additions & 63 deletions docs/config.json

This file was deleted.

198 changes: 0 additions & 198 deletions docs/deployment.md

This file was deleted.

Loading

0 comments on commit 8b304a3

Please sign in to comment.