/aws-lakeformation-best-practices

OtherNOASSERTION

AWS Lake Formation Best Practices

A best practices guide for using Lake Formation.

This guide is open for anyone to make changes and suggest new content. If there is new content that you would like to see or inaccurate information that needs to be fixed, please open an Issue or contribute it.

Adding new content

This repo uses mkdocs and is hosted on Github. To get started and creating content, the easiest way is to use poetry. The following commands should get you started:

  • You can install poetry using brew install poetry if you are running on MacOS. If you are using a different OS, please see the installation instructions for your OS.
  • poetry install that will create a virtual python environment and install the necessary dependencies.
  • To run the local version of mkdocs and to preview changes in real-time, run poetry shell and once in the virtual environment, run mkdocs serve.
  • Make your changes, preferably on a branch for large updates.
  • Create a Github pull request with your changes to be reviewed and merged.

Rules on contributions

  1. We will try to review and provide comment within 1 week. If we do not meet this timeline, or have an urgent request, please email us (see below).
  2. If we feel that content is best served to be within our public documentation, we will submit your content to our doc writers and close the pull request.
  3. We will not accept any code that is written as utilities from those that are outside of AWS as anything we publish here must go through Security Reviews within AWS.
  4. Before writing any significant content, its recommend that you open an Issue and validate that the content that you intend to write
  5. We currently have a backlog of content that we want to write. If you are interested in contributing but do not know what topics to write about, please email us (see below).

Return to Live Docs.

Contact

If you have any feedback or wish to contact the owners of this repo, please email aws-bda-lf+best-practices AT amazon.com.

License Summary

The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.

The sample code within this documentation is made available under the MIT-0 license. See the LICENSE-SAMPLECODE file.