Skip to content

3 #32

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

Closed
wants to merge 27 commits into from
Closed

3 #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
03ffd3b
Upgraded deps.
jogoodma Nov 17, 2018
4259c2b
Migrated github site to docusaurus.
jogoodma Apr 16, 2019
2172674
Removed old readme.
jogoodma Apr 16, 2019
6d102a1
Trying to fix publishing issues.
jogoodma Apr 16, 2019
ba7d83e
Trying to fix publishing issues.
jogoodma Apr 16, 2019
94f5763
Publishing issues.
jogoodma Apr 16, 2019
b70f17e
Publishing issues
jogoodma Apr 16, 2019
ff266bf
Local swagger-ui, symbol HowTo, Chado functions.
jogoodma Apr 23, 2019
5b11082
Added HowTo landing page.
jogoodma Apr 23, 2019
b03892b
Fixed broken HowTo link in footer.
jogoodma Apr 23, 2019
348f584
One more attempt at fixing the footer doc links.
jogoodma Apr 23, 2019
4332456
Downgraded to Docusaurus 1.8.3. Added links.
jogoodma Apr 24, 2019
187e633
Added search and clarified get_relationship.
jogoodma Apr 26, 2019
d3b9b35
Upgraded to 1.11.0. Changed sidebar index name.
jogoodma May 31, 2019
85d6315
Changed API endpoint to https.
jogoodma Jun 12, 2019
2bf889a
Upgraded to docusaurus 1.11.1
jogoodma Jun 12, 2019
9874728
Upgraded to docusaurus 1.11.1
jogoodma Jun 12, 2019
683556d
Bump lodash.merge from 4.6.1 to 4.6.2 in /website
dependabot[bot] Jul 11, 2019
26bfd45
Upgraded to 1.12.0
jogoodma Aug 15, 2019
ef6f963
Bump lodash from 4.17.11 to 4.17.15 in /website
dependabot[bot] Aug 15, 2019
ae217cb
Upgraded to 1.12.0
jogoodma Aug 15, 2019
50db813
Merge branch 'develop' of github.com:FlyBase/flybase.github.io into d…
jogoodma Aug 15, 2019
b3e6b3e
Merge pull request #3 from FlyBase/dependabot/npm_and_yarn/website/lo…
jogoodma Aug 15, 2019
bb37de0
Merge pull request #1 from FlyBase/dependabot/npm_and_yarn/website/lo…
jogoodma Aug 15, 2019
975af55
Merge branch 'develop' of github.com:FlyBase/flybase.github.io into d…
jogoodma Aug 15, 2019
bd8d7d5
Trying to fix broken merge.
jogoodma Aug 15, 2019
730b3e5
Update downloads.md
jimflybase Jul 2, 2025
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
2 changes: 2 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*/node_modules
*.log
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
node_modules
yarn-error.log


# Build directory
/public
build
.DS_Store
.idea
10 changes: 10 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
FROM node:8.11.4

WORKDIR /app/website

EXPOSE 3000 35729
COPY ./docs /app/docs
COPY ./website /app/website
RUN yarn install

CMD ["yarn", "start"]
203 changes: 178 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,193 @@
This website was created with [Docusaurus](https://docusaurus.io/).

## FlyBase GitHub Orgnization Website
# What's In This Document

This repository contains the code that generates the FlyBase
GitHub organization website hosted at https://flybase.github.io/
* [Get Started in 5 Minutes](#get-started-in-5-minutes)
* [Directory Structure](#directory-structure)
* [Editing Content](#editing-content)
* [Adding Content](#adding-content)
* [Full Documentation](#full-documentation)

### Background
# Get Started in 5 Minutes

This site uses [Gatsbyjs](https://www.gatsbyjs.org/) to produce the documentation.
1. Make sure all the dependencies for the website are installed:

### Content
```sh
# Install dependencies
$ yarn
```
2. Run your dev server:

Content for this site is generated via two main methods. Either via a React based
page under `src/pages/` or MD/MDX content under `src/content/`.
```sh
# Start the site
$ yarn start
```

MD stands for Markdown and MDX are Markdown files that can use JSX components.
## Directory Structure

#### Layouts, Header, Footer, CSS, etc.
Your project file structure should look something like this

The `src/components` directory contains most of the React and CSS code that drives the
main page layout.
```
my-docusaurus/
docs/
doc-1.md
doc-2.md
doc-3.md
website/
blog/
2016-3-11-oldest-post.md
2017-10-24-newest-post.md
core/
node_modules/
pages/
static/
css/
img/
package.json
sidebar.json
siteConfig.js
```

#### Adding pages
# Editing Content

To add content to the site, create a new React component under `src/pages` or
a new MD/MDX file under `src/content`.
## Editing an existing docs page

Any sub-directories created will be reflected in the URL path. In other words,
creating a file called `src/content/chado/queries/index.md` will populate a page
at `https://flybase.github.io/chado/queries/`.
Edit docs by navigating to `docs/` and editing the corresponding document:

### Commands
`docs/doc-to-be-edited.md`

List of yarn/npm commands:
* npm run develop - Starts the developer mode via a local webserver.
* npm run build - Builds/compiles the static site.
* npm run format - Formats all JS/JSX code under `src` using prettier
* npm run deploy - Builds and publishes the static site to the GitHub website.

```markdown
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---

Edit me...
```

For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)

## Editing an existing blog post

Edit blog posts by navigating to `website/blog` and editing the corresponding post:

`website/blog/post-to-be-edited.md`
```markdown
---
id: post-needs-edit
title: This Blog Post Needs To Be Edited
---

Edit me...
```

For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)

# Adding Content

## Adding a new docs page to an existing sidebar

1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:

```md
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---

My new content here..
```

1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:

```javascript
// Add newly-created-doc to the Getting Started category of docs
{
"docs": {
"Getting Started": [
"quick-start",
"newly-created-doc" // new doc here
],
...
},
...
}
```

For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)

## Adding a new blog post

1. Make sure there is a header link to your blog in `website/siteConfig.js`:

`website/siteConfig.js`
```javascript
headerLinks: [
...
{ blog: true, label: 'Blog' },
...
]
```

2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:

`website/blog/2018-05-21-New-Blog-Post.md`

```markdown
---
author: Frank Li
authorURL: https://twitter.com/foobarbaz
authorFBID: 503283835
title: New Blog Post
---

Lorem Ipsum...
```

For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)

## Adding items to your site's top navigation bar

1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:

`website/siteConfig.js`
```javascript
{
headerLinks: [
...
/* you can add docs */
{ doc: 'my-examples', label: 'Examples' },
/* you can add custom pages */
{ page: 'help', label: 'Help' },
/* you can add external links */
{ href: 'https://github.com/facebook/Docusaurus', label: 'GitHub' },
...
],
...
}
```

For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)

## Adding custom pages

1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:

`website/siteConfig.js`
```javascript
{
headerLinks: [
...
{ page: 'my-new-custom-page', label: 'My New Custom Page' },
...
],
...
}
```

For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).

# Full Documentation

Full documentation can be found on the [website](https://docusaurus.io/).
18 changes: 18 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: "3"

services:
docusaurus:
build: .
ports:
- 3000:3000
- 35729:35729
volumes:
- ./docs:/app/docs
- ./website/blog:/app/website/blog
- ./website/core:/app/website/core
- ./website/i18n:/app/website/i18n
- ./website/pages:/app/website/pages
- ./website/static:/app/website/static
- ./website/sidebars.json:/app/website/sidebars.json
- ./website/siteConfig.js:/app/website/siteConfig.js
working_dir: /app/website
25 changes: 25 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
id: index
title: API Overview
sidebar_label: Overview
---

## Description

The FlyBase APIs provide access to data such as
[sequence data](/api/swagger-ui/#/Sequence), [gene summaries](/api/swagger-ui/#/Gene%20Summaries),
[protein domains](/api/swagger-ui/#/Domains), [Chado XML](/api/swagger-ui/#/Chado), and more.

## API docs

* [API docs](/api/swagger-ui/)
* [OpenAPI 3.0 JSON](https://api.swaggerhub.com/apis/FlyBase/FlyBase/1.0)

## Rate limits

Please limit the number of your requests to no more than 3 per second.
Anything over that will result in throttling or a complete ban.

## Suggestions

Have an idea for a service endpoint? Please [contact us](http://flybase.org/contact/email).
Loading
Loading