From 595a561943622fe84976554d6d050a339cb42c94 Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Fri, 22 Jul 2022 12:45:35 -0400 Subject: [PATCH 1/7] Create API_overview.md API overview document draft --- API_overview.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 API_overview.md diff --git a/API_overview.md b/API_overview.md new file mode 100644 index 0000000..6226b93 --- /dev/null +++ b/API_overview.md @@ -0,0 +1,53 @@ + +## About the Chronologue API +
+ +The Chronologue API is open-source software that stores data about astronomical events. You can easily query astronomical data stored in the API and visualize events on the Chronologue website. + +The main purpose of Chronologue API is to help scientists and organizations advance humanity's knowledge. To query and visualize an astronomical event, you need an HTTP client, for example, Chrome. + +Developers can contribute to the software by joining the Chronologue Project, which is part of The Good Docs project. To contribute to program code, you should be familiar with the following tools: + +- Next.js +- Netlify hosting infrastructure + +To learn more, join our [Slack community](https://thegooddocs.slack.com/) or attend a [Chronologue meeting](https://thegooddocsproject.dev/community/). + +
+ +## Main features +
+ +Besides querying and visualizing past astronomical events, you can also use the Chronologue telescope to predict future events, but the accuracy of these predictions is not guaranteed. If an event has not yet been stored in the API, you can also request to post a new event. + +To use the Chronologue API, read and follow the steps described in the "Request for a new recording" document. If your request is approved, you will receive a notification email containing an API Key that gives you access to the Chronologue's API. + +The Chronologue API follows REST architecture. You can access the API's resources via HTTP requests and responses are given in JSON format. + + +
+ + + +![Chronologue API workflow]([https://drive.google.com/drive/u/0/folders/14g-_MmJNaUcYEs6nGl15Er5_Yj9JsCLS](https://drive.google.com/file/d/1QbjvwEExwCyPqTe0YeRo65lyi5g3pfo5/view?usp=sharing)) +A high-level diagram of the Chronologue API's workflow. + + + +
+
+ +## Common use cases +
+ +#### Academic research + +Gather information with the Chronologue API to further humanity's understanding. You can visualize past events that can help you explain what circumstances caused a another phenomenon of nature. + +Use the Chronologue API to test your hypothesis. The Chronologue API can make predictions about future astronomical events. You can compare your predictions to those prouced by the API as a way to validate your hypothesis. + +
+ +#### Educational purposes + +Demonstrate to your audience the causal relationship between two natural events. For example, you can show your students the asteroid's impact on Earth during the Cretaceous Period that caused the mass extinction of three-quarters of plant and animal species. From 91c4764b48b4aa8a48253331f5589e4b5f6ca720 Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Sun, 28 Aug 2022 15:42:22 -0400 Subject: [PATCH 2/7] Update API_overview.md Adding Tina's rephrasing Co-authored-by: Tina Luedtke --- API_overview.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/API_overview.md b/API_overview.md index 6226b93..7bd8e51 100644 --- a/API_overview.md +++ b/API_overview.md @@ -18,7 +18,10 @@ To learn more, join our [Slack community](https://thegooddocs.slack.com/) or att ## Main features
-Besides querying and visualizing past astronomical events, you can also use the Chronologue telescope to predict future events, but the accuracy of these predictions is not guaranteed. If an event has not yet been stored in the API, you can also request to post a new event. +The Chronologue time travel telescope records astronomical events of the past and future. It stores the events in the [data.json](https://github.com/thegooddocsproject/chronologue/blob/main/data/data.json) file as event objects. You can use the Chronologue API to query exisiting astronomical events from the `data.json file`. +If you want to retrieve data for an event that does not yet exist, you need to request a new recording. + +> Note: The Chronologue telescope predicts future events, but the accuracy of these predictions is not guaranteed. To use the Chronologue API, read and follow the steps described in the "Request for a new recording" document. If your request is approved, you will receive a notification email containing an API Key that gives you access to the Chronologue's API. From b15766cd013e9763ebbfab687b4784f123785d3a Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Sun, 28 Aug 2022 15:45:25 -0400 Subject: [PATCH 3/7] Update API_overview.md Change H4 ->H3 Co-authored-by: Tina Luedtke --- API_overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API_overview.md b/API_overview.md index 7bd8e51..fe3d042 100644 --- a/API_overview.md +++ b/API_overview.md @@ -43,7 +43,7 @@ A high-level diagram of the Chronologue API's workflow. ## Common use cases
-#### Academic research +### Academic research Gather information with the Chronologue API to further humanity's understanding. You can visualize past events that can help you explain what circumstances caused a another phenomenon of nature. From 6a9e3d732f3ecd59e2866496cc663f2e5e947c6c Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Sun, 28 Aug 2022 15:47:13 -0400 Subject: [PATCH 4/7] Update API_overview.md H4 ->H3 Co-authored-by: Tina Luedtke --- API_overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API_overview.md b/API_overview.md index fe3d042..18d07bd 100644 --- a/API_overview.md +++ b/API_overview.md @@ -51,6 +51,6 @@ Use the Chronologue API to test your hypothesis. The Chronologue API can make pr
-#### Educational purposes +### Educational purposes Demonstrate to your audience the causal relationship between two natural events. For example, you can show your students the asteroid's impact on Earth during the Cretaceous Period that caused the mass extinction of three-quarters of plant and animal species. From 6a4a270f2b9be0807ebedba5538aab9485aed6ba Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Mon, 19 Sep 2022 13:46:40 -0400 Subject: [PATCH 5/7] Update API_overview.md First reviewed --- API_overview.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/API_overview.md b/API_overview.md index 18d07bd..d975a81 100644 --- a/API_overview.md +++ b/API_overview.md @@ -2,30 +2,25 @@ ## About the Chronologue API
-The Chronologue API is open-source software that stores data about astronomical events. You can easily query astronomical data stored in the API and visualize events on the Chronologue website. +The Chronologue API is open-source interface that provides data about astronomical events. You can easily query astronomical data stored in the API and visualize events on the Chronologue website. -The main purpose of Chronologue API is to help scientists and organizations advance humanity's knowledge. To query and visualize an astronomical event, you need an HTTP client, for example, Chrome. +The main purpose of the Chronologue API is to help scientists and organizations advance humanity's knowledge. To query and visualize an astronomical event, you need an HTTP client, for example, a web browser. -Developers can contribute to the software by joining the Chronologue Project, which is part of The Good Docs project. To contribute to program code, you should be familiar with the following tools: - -- Next.js -- Netlify hosting infrastructure - -To learn more, join our [Slack community](https://thegooddocs.slack.com/) or attend a [Chronologue meeting](https://thegooddocsproject.dev/community/). +The Chronologue API follows a REST architecture. You can access the API's resources via HTTP requests and responses are given in JSON format. +
## Main features
-The Chronologue time travel telescope records astronomical events of the past and future. It stores the events in the [data.json](https://github.com/thegooddocsproject/chronologue/blob/main/data/data.json) file as event objects. You can use the Chronologue API to query exisiting astronomical events from the `data.json file`. -If you want to retrieve data for an event that does not yet exist, you need to request a new recording. +The Chronologue telescope records astronomical events of the past and the future. It stores the events in a [data.json] file (https://github.com/thegooddocsproject/chronologue/blob/main/data/data.json) as event objects. You can use the Chronologue API to query exisiting astronomical events from the `data.json file`. -> Note: The Chronologue telescope predicts future events, but the accuracy of these predictions is not guaranteed. +If you want to retrieve data for an event that does not yet exist, you have to make a request to record a new recording. -To use the Chronologue API, read and follow the steps described in the "Request for a new recording" document. If your request is approved, you will receive a notification email containing an API Key that gives you access to the Chronologue's API. +> Note: The Chronologue telescope predicts future events, but the accuracy of these predictions is not guaranteed. -The Chronologue API follows REST architecture. You can access the API's resources via HTTP requests and responses are given in JSON format. +Read and follow the steps described in the "Request for a new recording" document. Fill out and submit the provided form and, if your request is approved, you will receive a notification email with access to the Chronologue API.
@@ -40,10 +35,10 @@ A high-level diagram of the Chronologue API's workflow.

-## Common use cases +## Use cases
-### Academic research +- **Academic research** Gather information with the Chronologue API to further humanity's understanding. You can visualize past events that can help you explain what circumstances caused a another phenomenon of nature. @@ -51,6 +46,15 @@ Use the Chronologue API to test your hypothesis. The Chronologue API can make pr
-### Educational purposes +- **Educational purposes** Demonstrate to your audience the causal relationship between two natural events. For example, you can show your students the asteroid's impact on Earth during the Cretaceous Period that caused the mass extinction of three-quarters of plant and animal species. + +---------------------------------------------------------------------------------------------- + +Developers can contribute to the software by joining the Chronologue Project, which is part of The Good Docs project. To contribute to program code, you should be familiar with the following tools: + +- Next.js +- Netlify hosting infrastructure + +To learn more, join our [Slack community](https://thegooddocs.slack.com/) or attend a [Chronologue meeting](https://thegooddocsproject.dev/community/). From 17adeeaf131b952d60eb6b9c9ae7d402431ae9fd Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Mon, 19 Sep 2022 13:50:44 -0400 Subject: [PATCH 6/7] Update API_overview.md --- API_overview.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/API_overview.md b/API_overview.md index d975a81..7dc9a2e 100644 --- a/API_overview.md +++ b/API_overview.md @@ -27,7 +27,7 @@ Read and follow the steps described in the "Request for a new recording" documen -![Chronologue API workflow]([https://drive.google.com/drive/u/0/folders/14g-_MmJNaUcYEs6nGl15Er5_Yj9JsCLS](https://drive.google.com/file/d/1QbjvwEExwCyPqTe0YeRo65lyi5g3pfo5/view?usp=sharing)) +![Chronologue API workflow]([https://drive.google.com/file/d/12_D--AJbQu7b8yJQFHbnTMpBIo_mZ9G5/view?usp=sharing]) A high-level diagram of the Chronologue API's workflow. @@ -52,6 +52,8 @@ Demonstrate to your audience the causal relationship between two natural events. ---------------------------------------------------------------------------------------------- +## How to contribute + Developers can contribute to the software by joining the Chronologue Project, which is part of The Good Docs project. To contribute to program code, you should be familiar with the following tools: - Next.js From 9d4992014a15f2b54e287c7a8c717898e8f25d27 Mon Sep 17 00:00:00 2001 From: Valeria Hernandez Luzardo Date: Mon, 19 Sep 2022 17:04:58 -0400 Subject: [PATCH 7/7] Update API_overview.md Workflow link update --- API_overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/API_overview.md b/API_overview.md index 7dc9a2e..6e7d0f9 100644 --- a/API_overview.md +++ b/API_overview.md @@ -27,7 +27,7 @@ Read and follow the steps described in the "Request for a new recording" documen -![Chronologue API workflow]([https://drive.google.com/file/d/12_D--AJbQu7b8yJQFHbnTMpBIo_mZ9G5/view?usp=sharing]) +![Chronologue API workflow](https://drive.google.com/file/d/12_D--AJbQu7b8yJQFHbnTMpBIo_mZ9G5/view?usp=sharing) A high-level diagram of the Chronologue API's workflow.