diff --git a/deploy_docs.sh b/deploy_docs.sh new file mode 100755 index 0000000..4ef9bff --- /dev/null +++ b/deploy_docs.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +cd docs +command -v mkdocs 2>/dev/null 2>&1 || { echo >&2 "Command mkdocs not found. Are you in the right venv?"; exit 1; } +mkdocs build +rsync -auv ./site/* armadillica@attract.studio:/home/armadillica/attract.studio/docs diff --git a/docs/docs/developer_docs/roadmap.md b/docs/docs/developer_docs/roadmap.md new file mode 100644 index 0000000..c5ec2a0 --- /dev/null +++ b/docs/docs/developer_docs/roadmap.md @@ -0,0 +1,12 @@ +# Roadmap +The day-to-day planning for development is available on +[developer.blender.org](https://developer.blender.org/project/board/72/). In this section we summarize +the high level goals for the projects. + +## Self-provisionable Server +Make it possible for developers to run the full stack in a local environment. In similar way to +Flamenco, the challenge is to get the Server (and its Pillar core) disconnected from Blender Cloud. + +## Data filtering and sorting +Provide basic filtering and sorting functionality for assets, tasks, and assets. For example, make it +possible to find all tasks assigned to a specific user, or in a specific set of statuses. diff --git a/docs/docs/img/logo_attract_white.svg b/docs/docs/img/logo_attract_white.svg new file mode 100644 index 0000000..7369e8c --- /dev/null +++ b/docs/docs/img/logo_attract_white.svg @@ -0,0 +1,74 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/docs/docs/index.md b/docs/docs/index.md new file mode 100644 index 0000000..0ac1df4 --- /dev/null +++ b/docs/docs/index.md @@ -0,0 +1,17 @@ +# Attract Docs + +Welcome to the Attract documentation pages! Here we collect both user and development docs. Attract +is the production tracking and management software used at Blender Animation Studio. + +## Main features + +* Shot list, asset list and task list +* Extensible design, supporting custom task types with custom attributes +* Integration of SVN activity in a task activity list +* Completely Free and Open Source software + +## Status of the documentation + +Documentation is an ongoing effort. We are currently focusing on user documentation, aimed at +Blender Cloud subscribers. If you are interested in installing Attract on your own infrastructure, +consider checking out the sources and README.md files. diff --git a/docs/docs/user_manual/installation.md b/docs/docs/user_manual/installation.md new file mode 100644 index 0000000..1cb7f45 --- /dev/null +++ b/docs/docs/user_manual/installation.md @@ -0,0 +1,10 @@ +# Installation & Configuration + +!!! note + This section of the manual is work in progress. + +The following video shows how to set up a Blender Cloud project with Attract, which is currently +the only way officially supported. A step-by-step text version will follow. + + diff --git a/docs/docs/user_manual/introduction.md b/docs/docs/user_manual/introduction.md new file mode 100644 index 0000000..d3d808f --- /dev/null +++ b/docs/docs/user_manual/introduction.md @@ -0,0 +1,6 @@ +# Introduction + +!!! note + This section of the manual is work in progress. + +This manual aims at describing the features of Attract and providing examples on how to use them. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml new file mode 100644 index 0000000..af94881 --- /dev/null +++ b/docs/mkdocs.yml @@ -0,0 +1,41 @@ +# Project information +site_name: 'Attract' +site_description: 'Free and Open Source production tracking for film makers' +site_author: 'Blender Institute' +site_url: 'https://attract.studio/' + +# Repository +repo_name: 'armadillica/attract' +repo_url: 'https://github.com/armadillica/attract' + +# Copyright +copyright: 'Copyright © 2016 Blender Institute - CC-BY-SA v4.0.' + +theme: + name: 'material' + logo: 'img/logo_attract_white.svg' + palette: + primary: 'blue grey' + accent: 'deep orange' + social: + - type: 'github' + link: 'https://github.com/armadillica' + - type: 'twitter' + link: 'https://twitter.com/Blender_Cloud' + +pages: + - Home: 'index.md' + - User Manual: + - 'user_manual/introduction.md' + - 'user_manual/installation.md' + - Developer Docs: + - 'developer_docs/roadmap.md' + + +# Google Analytics +google_analytics: + - 'UA-13043630-10' + - 'auto' + +markdown_extensions: + - admonition diff --git a/requirements-dev.txt b/requirements-dev.txt index 6161585..873e668 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -3,3 +3,8 @@ -r ../pillar/requirements-dev.txt -e ../attract # also works from parent project, like blender-cloud + + +# Primary requirements +mkdocs==0.17.2 +mkdocs-material==2.2.2