Ensembl project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- Ensembl
- Technical writer:
- laurelm
- Project name:
- REST API documentation
- Project length:
- Standard length (3 months)
Project description
Enhance the developer user guide for using the Ensembl REST API
Main focus -- Provide a more user friendly introduction/getting started section.
Proposed implementation is based along the lines of these doc pages:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Main page:
Includes these sections (high level view):
Overview of what this API provides in practical terms
Short intro to REST
A quick example
Authentication info
Introduction to how the URLs are structured using various HTTP methods
Info on the required and optional parameters and where they are found in the auto-generated endpoint documentation.
Link to the following training page:
https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Info on helper_functions that are used in the training course
Subsequent pages
Depending on complexity of the topics listed in the main page, some topics may need to link to subsequent detail pages.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["\u003cp\u003eThis project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course.\u003c/p\u003e\n"],["\u003cp\u003eCertain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding.\u003c/p\u003e\n"],["\u003cp\u003eThis is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months.\u003c/p\u003e\n"]]],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"],null,["# Ensembl project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n---------------\n\nOpen source organization:\n: Ensembl\n\nTechnical writer:\n: laurelm\n\nProject name:\n: REST API documentation\n\nProject length:\n: Standard length (3 months)\n\nProject description\n-------------------\n\nEnhance the developer user guide for using the Ensembl REST API\n\n*** ** * ** ***\n\nMain focus -- Provide a more user friendly introduction/getting started section.\n\nProposed implementation is based along the lines of these doc pages:\n\n\u003chttps://developers.google.com/maps/documentation/maps-static/intro\u003e\n\n\u003chttps://developers.google.com/maps/documentation/maps-static/dev-guide\u003e\n\n*** ** * ** ***\n\n### Main page:\n\nIncludes these sections (high level view):\n\n- Overview of what this API provides in practical terms\n\n- Short intro to REST\n\n- A quick example\n\n- Authentication info\n\n- Introduction to how the URLs are structured using various HTTP methods\n\n- Info on the required and optional parameters and where they are found in the auto-generated endpoint documentation.\n\n- Link to the following training page:\n \u003chttps://www.ebi.ac.uk/training/online/course/ensembl-rest-api\u003e\n\n- Info on helper_functions that are used in the training course\n\n*** ** * ** ***\n\n### Subsequent pages\n\nDepending on complexity of the topics listed in the main page, some topics may need to link to subsequent detail pages.\n\n*** ** * ** ***"]]
