https://github.com/lucperkins/data-driven-documentation

https://github.com/lucperkins/data-driven-documentation

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/lucperkins/data-driven-documentation
• Owner: lucperkins
• Created: 2020-07-18T23:32:09.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-19T00:53:50.000Z (over 4 years ago)
• Last Synced: 2024-11-14T01:14:43.341Z (2 months ago)
• Size: 1.95 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Data-driven documentation (DDD)

I created this repo to provide examples of data-driven documentation to accompany my talk for [Write the Docs](https://www.writethedocs.org/conf/portland/2020/) 2020 in Portland (RIP CITY!).

> Feel free to add your own favorites via pull request!

## Projects I've worked on

### Download pages

Page | Important files

:----|:---------------

[SPIRE](https://spiffe.io/downloads) | [HTML template](https://github.com/spiffe/spiffe.io/blob/master/layouts/shortcodes/releases.html)

[containerd](https://containerd.io/downloads) | [HTML template](https://github.com/containerd/containerd.io/blob/master/layouts/shortcodes/releases.html)

### Command-line tools

Page | Important files

:----|:---------------

[Jaeger](https://www.jaegertracing.io/docs/latest/cli) | [Data](https://github.com/jaegertracing/documentation/tree/master/data/cli), [HTML template](https://github.com/jaegertracing/documentation/blob/master/themes/jaeger-docs/layouts/shortcodes/cli/tools-list.html)

## Other projects

### API docs

* [Stripe REST API Reference](https://stripe.com/docs/api) (considered by many to be the Gold Standard of API docs)

* [GitHub GraphQL API docs](https://docs.github.com/en/graphql)

* [Twilio REST API](https://www.twilio.com/docs/usage/api)

* [TensorFlow Core API](https://www.tensorflow.org/api_docs/)

### Download pages

* [Vector components](https://vector.dev/components)

### Command-line tools

* [Firebase CLI reference](https://firebase.google.com/docs/cli)

* [Amazon Web Services CLI reference](https://docs.aws.amazon.com/cli/latest/reference)

* [AngularJS CLI reference](https://angular.io/cli)

* [Microsoft Azure CLI reference](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest)

* [kubectl (Kubernetes CLI) reference](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands)