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

Current Documentation #104

Open
laceysanderson opened this issue Mar 31, 2024 · 1 comment
Open

Current Documentation #104

laceysanderson opened this issue Mar 31, 2024 · 1 comment
Labels
Group 0 - General Maintenance Any issue that doesn't fit into the other groups (i.e. docker, github actions)

Comments

@laceysanderson
Copy link
Member

laceysanderson commented Mar 31, 2024

We NEED current documentation for the upgraded version of this module!

I started this with PR #103 and am now creating this issue to document the process.

That PR adds a skeleton of documentation for this module (more a plan then actual documentation at this point) using mkdocs and the Material Theme.

How to develop these docs:

cd docs
docker build --tag trpblast:docs ./
docker run --rm --volume=$(pwd):/tripal_blast trpblast:docs mkdocs build
open site/index.html

To see something like the following:
image

And the current navigation is:

  • Home
  • Installation
    • Adding to an existing site
    • Demonstration via Docker
  • Guiding your Users
    • Submitting a BLAST request
    • Finding previous requests
    • BLAST result page
  • Site Administration
    • Configuring BLAST
    • Managing BLAST databases
    • Running jobs automatically
@laceysanderson
Copy link
Member Author

Docs now include installation information:
image

image

@laceysanderson laceysanderson added the Group 0 - General Maintenance Any issue that doesn't fit into the other groups (i.e. docker, github actions) label Mar 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Group 0 - General Maintenance Any issue that doesn't fit into the other groups (i.e. docker, github actions)
Projects
None yet
Development

No branches or pull requests

1 participant