-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: major reorg to new top level sections (#2632)
* This is not a complete rewrite of the docs, just moving things around * Moves the top level folders to the right place and fixes all the broken links * Needs subsequent PRs for content
- Loading branch information
Showing
99 changed files
with
381 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
apps/docs/docs/how-oso-works/_category_.json → ...docs/docs/contribute-data/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| { | ||
| "label": "Learn How OSO Works", | ||
| "label": "Contribute Data", | ||
| "position": 5, | ||
| "link": { | ||
| "type": "doc", | ||
|
|
||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions
4
apps/docs/docs/contribute/_category_.json → ...cs/docs/contribute-models/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "label": "Get Started", | ||
| "position": 1, | ||
| "link": { | ||
| "type": "doc", | ||
| "id": "index" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| --- | ||
| title: "Get started with OSO API" | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| The [OSO](https://www.opensource.observer) API serves | ||
| queries on metrics and metadata about open source projects. | ||
| It is a [GraphQL](https://graphql.org/) API backed by the | ||
| [OSO data pipeline](../guides/architecture.md). | ||
|
|
||
| Let's make your first query in under five minutes. | ||
|
|
||
| ## Generate an API key | ||
|
|
||
| First, go to [www.opensource.observer](https://www.opensource.observer) and create a new account. | ||
|
|
||
| If you already have an account, log in. Then create a new personal API key: | ||
|
|
||
| 1. Go to [Account settings](https://www.opensource.observer/app/settings) | ||
| 2. In the "API Keys" section, click "+ New" | ||
| 3. Give your key a label - this is just for you, usually to describe a key's purpose. | ||
| 4. You should see your brand new key. **Immediately** save this value, as you'll **never** see it again after refreshing the page. | ||
| 5. Click "Create" to save the key. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| ## Prepare your query | ||
|
|
||
| You can navigate to our | ||
| [public GraphQL explorer](https://www.opensource.observer/graphql) | ||
| to explore the schema and execute test queries. | ||
|
|
||
|  | ||
|
|
||
| For example, this query will fetch the first 10 projects in | ||
| [oss-directory](https://github.com/opensource-observer/oss-directory). | ||
|
|
||
| ```graphql | ||
| query GetProjects { | ||
| oso_projectsV1(limit: 10) { | ||
| description | ||
| displayName | ||
| projectId | ||
| projectName | ||
| projectNamespace | ||
| projectSource | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Issue your first API request | ||
|
|
||
| All API requests are sent to the following URL: | ||
|
|
||
| ``` | ||
| https://www.opensource.observer/api/v1/graphql | ||
| ``` | ||
|
|
||
| In order to authenticate with the API service, you have to use the `Authorization` HTTP header and `Bearer` authentication on all HTTP requests | ||
|
|
||
|
|
||
| <Tabs> | ||
| <TabItem value="curl" label="curl" default> | ||
| ```bash | ||
| curl -X POST \ | ||
| -H "Content-Type: application/json" \ | ||
| -H "Authorization: Bearer $DEVELOPER_API_KEY" \ | ||
| -d '{"query":"query GetProjects { oso_projectsV1(limit: 10) { description displayName projectId projectName projectNamespace projectSource } }"}' \ | ||
| https://www.opensource.observer/api/v1/graphql | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="javascript" label="JavaScript"> | ||
| ```js | ||
| const query = ` | ||
| query GetProjects { | ||
| oso_projectsV1(limit: 10) { | ||
| description | ||
| displayName | ||
| projectId | ||
| projectName | ||
| projectNamespace | ||
| projectSource | ||
| } | ||
| } | ||
| `; | ||
| const headers = { | ||
| 'Content-Type': 'application/json', | ||
| 'Authorization': `Bearer ${DEVELOPER_API_KEY}`, | ||
| }; | ||
|
|
||
| const response = await fetch('https://www.opensource.observer/api/v1/graphql', { | ||
| method: 'POST', | ||
| headers: headers, | ||
| body: JSON.stringify({ | ||
| query: query | ||
| }), | ||
| }); | ||
|
|
||
| const data = await response.json(); | ||
| console.log(data); | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="python" label="Python"> | ||
| ```python | ||
| import requests | ||
|
|
||
| query = """ | ||
| query GetProjects { | ||
| oso_projectsV1(limit: 10) { | ||
| description | ||
| displayName | ||
| projectId | ||
| projectName | ||
| projectNamespace | ||
| projectSource | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| headers = { | ||
| 'Content-Type': 'application/json', | ||
| 'Authorization': f'Bearer {DEVELOPER_API_KEY}' | ||
| } | ||
|
|
||
| response = requests.post( | ||
| 'https://www.opensource.observer/api/v1/graphql', | ||
| json={'query': query}, | ||
| headers=headers | ||
| ) | ||
|
|
||
| data = response.json() | ||
| print(data) | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
|
||
| ## Next steps | ||
|
|
||
| Congratulations! You've made your first API request. | ||
| Now try one of our tutorials. | ||
|
|
||
| - [Analyze a collection of projects](../tutorials/collection-view) | ||
| - [Deep dive into a project](../tutorials/project-deepdive) |
Oops, something went wrong.