Add a roadmap_to_1.0 document to developer_resources/

[ehmatthes]

These questions come up for every new plugin:

• How can I tell if a django-simple-deploy plugin can support a particular platform/ workflow?
• How do I get started implementing a plugin for a particular platform?
• How do I know when it's ready for a 1.0 release?

Tasks

• Generate a doc in developer_resources/ that writes a customized Roadmap to 1.0 doc that can be used to guide development, and as a broad first issue.
• Merge
• Share with existing plugin maintainers who might find value in this.

[ehmatthes]

Roadmap to 1.0

The tasks in this list do not need to be implemented in order. For example, sometimes it's easier to start with the fully automated mode, and other times it's easier to start by implementing the configuration-only workflow.

• Preplanning
  • Is this a suitable platform for a django-simple-deploy plugin?
    • Is there a way to reliably configure a typical Django project to this platform?
    • Is there a CLI or API that you can leverage to do things like generate projects, provision resources, push code, etc?
  • If the platform seems suitable, where will you leave dsd users? Can you clearly describe how you'd expect them to carry out their next redeployment after making some local changes?
  • How will users run management commands on the production project after running deploy?
  • For testing purposes, can you clearly articulate how to destroy a test project?
  • Do you plan to support --automate-all?
  • Do you plan to support the configuration-only approach?
• --automate-all deployment
  • A run of manage.py deploy --automate-all works for the sample project, from your local system.
  • Update integration tests to pass (nice to have).
  • Write an e2e test (critical for ongoing support, and making releases).
  • All external messages are accurate, and give users the information they need to understand what was done for the initial deployment. There's a clear summary of how to make the next deployment.
  • Reports the URL of the deployed project.
• configuration-only mode
  • A run of manage.py deploy works for the sample project, from your local system.
  • Update integration tests to pass (nice to have).
  • Write an e2e test (critical for ongoing support, and making releases).
  • All external messages have been are accurate, and give users the information they need to understand what was done for the initial deployment. There's a clear summary of how to make the next deployment.
• Both modes:
  • Implements _validate_platform(), to check for any reasons the deployment might fail. ie, user is not authenticated through the required CLI.
  • Sets a reasonably specific ALLOWED_HOSTS.
  • If the plugin implements a git push based deployment process, the name of the branch to push is checked. ie, avoid accidentally pushing a dev branch.
  • Consider whether there are any custom CLI args you'd like to support, such as --db-size, --db.
• Integration tests (work without any network access)
  • Integration tests pass on macOS.
  • Integration tests pass on Windows.
  • Integration tests pass on at least one mainstream flavor of Linux.
• E2e tests (carry out a full deployment)
  • E2e tests pass on macOS.
  • E2e tests pass on Windows.
  • E2e tests pass on at least one mainstream flavor of Linux.
• Docs
  • Can be a simple README, but there's a clear Quick Start for each mode that's supported (configuration-only and/or fully automated).
  • If there are any requirements such as setting env vars, API keys, SSH setup, etc, those are described clearly. Links to specific parts of platform's docs are helpful. Links to a platform's main docs page are not particularly helpful.
  • Consider including a curated set of links to the most useful pages or sections of the platform's documenation, ie "Python on <platform-name", or "Django on ".
• Other:
  • Works if the user already has a project deployed to that platform.
  • Ideal: someone familiar with another plugin does a brief audit of the overall deployment approach.
• Share!
  • No one uses a plugin unless people talk about it. Share your 1.0 release somewhere that people might see it: Django Forum, share with other dsd developers, django news, pycoder's weekly, social media...