Open tebanieo opened 5 months ago
After discussing internally with @arjanschaaf, we are suggesting to mode the workshops
folder out of this repository to the amazon-dynamodb-labs and use it as a central place.
Great proposal overall. I have two suggestions:
deprecated
" I would recommend calling this "archived", or something along the lines of "no longer supported". We don't want to give the impression that we're updating/maintaining those previous code samples, but until the code samples are actually obsolete (or straight up just don't work, and we're not going to fix them), I think it'd be a mistake to disavow them completely.
README.md
in that folder explaining "these code samples may not work and are preserved for historical archival purposes" should be sufficient as a "warning" for users who randomly happen upon them.
This repository has been growing over the years with examples from different programing languages and some extra functionality.
I think the README.MD should be updated as it redirects readers to different top level folders that don't follow a structure.
I need your feedback about this folder structre that I am proposing below:
infrastructure_as_code
: The folder will include all the templates used to deploy DynamoDB to an AWS accountcloudformation
: One folder per solution that includes a deployable cloudformation template, the project MUST have a README.MD file that explains the need of the template.cdk
: One folder per solution that includes a deployable CDK project. The project MUST have a README.MD file that explains why this project is important, the pre-requisites and how to deploy it.security
: IAM policies examples in JSON format, optionally you can include CDK and cloudformation examples.workshops
: All the workshops created in this repository, one workshop per folder with a brief description, this folder should have aREADME.MD
file explaining this in detail. A workshop is intended to be a self serviceschema_design
: This folder contains all the examples and sample code that promotes schema design libraries.README.MD
is needed here.deprecated
: Any content that is not longer useful/valid.local_development
: This is the folder that will include local development instructions.sdk-examples
: This directory will replace theDynamoDB-SDK-Examples
.README.MD
needs re-work to keep up with all the examples that we have in this folder.language
folder I recommend to have top level versions ex:javascript/v3
orjavascript/v2
, followed by acontrol_plane
,data_plane
folder for example:javascript
v3
data_plane
table_operations
scan
...stream_operations
Code quality:
language
folder, for exampledataset.json
or just use the same values for your examples.README.MD
to provide useful explanations for your code, let the code be the code.