veselosky/bluebucket_experiment

Tools I use for publishing static sites

bluebucket_experiment's Issues

CollectionPage

Implement basic support for Collection Pages:

• CollectionPage JSON schema
• Template for HTML
• Lambda: CollectionPage->HTML
• Configure extension validator and spectator

CollectionPage JSON -> CollectionPageList

When a CollectionPage is created, add it to the CollectionPageList, so that it will be rebuilt when the item index changes.

Update CollectionPages

• Lambda: UpdateCollectionPages. Invokes ArchiveChanged for every collection page in CollectionPageList
• Configure Spectator CollectionItemIndex -> UpdateCollectionPages

CLI: Generate config

Create a command that generates a config file from the internal example/default. Take a param that points to the config template to use.

• Library function: load config (from local FS, fetchable URL, or bucket)
• Library function: generate config

ItemPage validation

Add logic for handling item pages.

• Schema for item page JSON
• Library function: validate item. Returns detailed explanation of errors.
• Lambda: Add Item (validates schema before storing)
• Configure validator

Spectator: PageJSON to HTML

Implement the spectator that produces HTML renditions of item pages.

• Template to produce Item HTML
• Lambda function
• Add spectator to bucket config
• Update installer as needed

ScheduleIndex

Keep an index of scheduled items that can be referenced by the scheduler.

• Schema for ScheduleIndex
• Configure validator for ScheduleIndex
• Lambda: UpdateScheduleIndex
• Configure Spectator ItemPage->ChangeScheduleIndex
• Configure Spectator AssetMeta->ChangeScheduleIndex
• Configure Spectator CollectionPage->ChangeScheduleIndex

JSON Schema for webquills config file

Should include:

• Site metadata
• Spectator subscriptions
• Metadata defaults
• Example config file

UpdateScheduledItems

• Lambda: UpdateScheduledItems. Checks the ScheduledItemIndex for things that need doing. Uses put-object-acl to change visibility to public. Invokes ArchiveChanged.
• Configure Schedule for UpdateScheduledItems

Collection Item Index

• Schema for CollectionItemIndex
• Update installer to create SQSCollectionItemIndex
• Configure spectator HTML -> SQSCollectionItemIndex.
• Lambda: UpdateCollectionItemIndex. Reads (and filters) messages from SQSCollectionItemIndex. If necessary, updates the index file.
• Schedule to trigger Lambda

CLI: CollectionPage as Markdown

AssetMeta validation

• Schema for AssetMeta
• Configure validator for AssetMeta

Lambda Function: ArchiveChanged

Implement the Lambda that distributes change notifications.

• Logic to invoke Lambda
• Logic to send to SQS
• Logic to distinguish between privileged and unprivileged spectators
• Update Installer as needed

CLI: Installer

CLI command to install AWS resources into your account and wire up the system.

• Create bucket if necessary
• PUT config to bucket
• PUT schemas to bucket

Out of scope, to be added in future ticket:

• Install Lambda functions
• Configure Lambda execution roles
• Configure S3 Event sources

Markdown support

Add ability to store files locally in Markdown format and push to archive in correct item page JSON format.

• Library function: Markdown to item page JSON
• CLI: PUT either JSON or Markdown file to archive. Invokes Lambda: Add Item To Archive.