Skip to content

Commit

Permalink
Big docs update
Browse files Browse the repository at this point in the history
- Changed wording, add more references between sections.
- Highlighted some details better.
- Reorganized discussion about L1s and L2s a bit to make it flow better.
- Changes the title of the section that used to be called "using l2s"
  into "writing CDK apps".
- Update formatting.
  • Loading branch information
Rico Huijbers committed May 30, 2018
1 parent 4168f10 commit eb96a68
Show file tree
Hide file tree
Showing 12 changed files with 522 additions and 385 deletions.
10 changes: 0 additions & 10 deletions packages/docs/build-docs.sh
Original file line number Diff line number Diff line change
@@ -1,16 +1,6 @@
#!/bin/bash
set -euo pipefail

PYTHON_DEPS="$PWD/python-deps"
mkdir -p "${PYTHON_DEPS}"

export PYTHONPATH=${PYTHON_DEPS}/lib/python3.6/site-packages
export PATH=${PYTHON_DEPS}/bin:$PATH

#----------------------------------------------------------------------
# Install python depednencies to a local tree
pip install --ignore-installed --install-option="--prefix=${PYTHON_DEPS}" -r requirements.txt

#----------------------------------------------------------------------
# CONFIG
staging="dist/staging"
Expand Down
18 changes: 7 additions & 11 deletions packages/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,13 @@
"name": "docs",
"private": true,
"version": "0.6.0",
"description": "AWS CDK Documentation",
"description": "Generates the documentation for all packages",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"repository": {
"type": "git",
"url": "git://github.com/awslabs/aws-cdk"
},
"pkglint": {
"ignore": true
},
"scripts": {
"prepare": "/bin/bash ./build-docs.sh"
},
Expand All @@ -20,12 +17,11 @@
"url": "https://aws.amazon.com"
},
"license": "Apache-2.0",
"devDependencies": {
"aws-cdk-all": "^0.6.0",
"pkgtools": "^0.6.0"
"dependencies": {
},
"keywords": [
"aws",
"cdk"
]
"devDependencies": {
"jsii-pacmak": "^0.4.0",
"pkgtools": "^0.6.0",
"aws-cdk-all": "^0.6.0"
}
}
Loading

0 comments on commit eb96a68

Please sign in to comment.