Ensembl-Projekt
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Ensembl
- Technischer Redakteur:
- laurelm
- Projektname:
- REST API-Dokumentation
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Die Entwickleranleitung für die Verwendung der Ensembl REST API verbessern
Hauptaugenmerk: Bieten Sie einen nutzerfreundlicheren Abschnitt mit einer Einführung und Informationen zum Einstieg.
Die vorgeschlagene Implementierung basiert auf den folgenden Dokumentseiten:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Hauptseite:
Sie enthält die folgenden Abschnitte (Übersicht):
Übersicht über den praktischen Nutzen dieser API
Kurze Einführung in REST
Kurzes Beispiel
Authentifizierungsinformationen
Einführung in die Strukturierung der URLs mithilfe verschiedener HTTP-Methoden
Informationen zu den erforderlichen und optionalen Parametern und dazu, wo sie in der Dokumentation zu automatisch generierten Endpunkten zu finden sind.
Link zur folgenden Schulungsseite:
https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informationen zu den Hilfsfunktionen, die im Trainingskurs verwendet werden
Nachfolgende Seiten
Je nach Komplexität der auf der Hauptseite aufgeführten Themen müssen einige Themen möglicherweise mit nachfolgenden Detailseiten verknüpft werden.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-11-08 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2024-11-08 (UTC)."],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The 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."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["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"]]
