https://github.com/jeshan/botodocs

Simple, navigable and fast documentation site for boto3 (unofficial)
https://github.com/jeshan/botodocs

boto3 docsify

Last synced: 2 months ago
JSON representation

Simple, navigable and fast documentation site for boto3 (unofficial)

• Host: GitHub
• URL: https://github.com/jeshan/botodocs
• Owner: jeshan
• License: bsd-2-clause
• Archived: true
• Created: 2020-04-12T17:35:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-04-29T09:06:39.000Z (over 3 years ago)
• Last Synced: 2024-11-29T22:06:38.454Z (10 months ago)
• Topics: boto3, docsify
• Language: Python
• Size: 706 KB
• Stars: 13
• Watchers: 3
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# botodocs: a (hopefully) better boto3 doc site

![](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiOXRZbVgzbnltSnowWGR2TVF3cDlqNEZPUjRXS2NLSVVLUjc2T0hJeWtwYlBSUUpyU1owZVFPRUFuVndadDk4TjVMSXFQQmhhRFIrYzRmc0QvSFJ2TVFRPSIsIml2UGFyYW1ldGVyU3BlYyI6Im82eXdQRTYxMzdmY1Y1czEiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

> Visit https://botodocs.com

# Why

I thought that the official docs has a lot of room to improve, so I built a "better" site in the meantime.

# Features

- lots of caching

- better navigation

- fast to load

- shorter pages

# Note to forkers:

This project uses docsify to convert the markdown files into a simple static website.

- `npm i docsify-cli -g`

- run `pipenv run python main.py` to generate the pages and serve a website (note that it calls `docsify serve docs` behind the scenes)

- Open browser at http://localhost:3000

- Edits to static files will be reloaded live. Otherwise rerun main.py for dynamic pages.

## Deploying on AWS

Uses the AWS CDK. See [lib/pipeline-construct.js](lib/pipeline-construct.js) for details on the deployment pipeline.

- `npm i -g aws-cdk`

- `cdk deploy`

This is what the CDK will deploy:

![](/diagram.png)

*Image automatically generated with [cfnbuddy](https://www.cfnbuddy.com)*

# Legal

Released under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)

https://creativecommons.org/licenses/by-nc-sa/4.0/

Project is based on boto3. Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed Apache Licence 2.0. See file [original-LICENCE](original-LICENCE) for details