Introducing docs 📚
This commit is contained in:
parent
da0f606110
commit
7fd4649a56
6
deploy_docs.sh
Executable file
6
deploy_docs.sh
Executable file
@ -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
|
||||
12
docs/docs/developer_docs/roadmap.md
Normal file
12
docs/docs/developer_docs/roadmap.md
Normal file
@ -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.
|
||||
74
docs/docs/img/logo_attract_white.svg
Normal file
74
docs/docs/img/logo_attract_white.svg
Normal file
@ -0,0 +1,74 @@
|
||||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
|
||||
<svg
|
||||
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
||||
xmlns:cc="http://creativecommons.org/ns#"
|
||||
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
width="512"
|
||||
height="512"
|
||||
id="svg2"
|
||||
version="1.1"
|
||||
inkscape:version="0.48.4 r9939"
|
||||
sodipodi:docname="logo_attract.svg"
|
||||
inkscape:export-filename="/shared/software/attract3/logo/attract_logo_bw_1080.png"
|
||||
inkscape:export-xdpi="90"
|
||||
inkscape:export-ydpi="90">
|
||||
<defs
|
||||
id="defs4" />
|
||||
<sodipodi:namedview
|
||||
id="base"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#666666"
|
||||
borderopacity="1.0"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pageshadow="2"
|
||||
inkscape:zoom="0.98994949"
|
||||
inkscape:cx="222.50239"
|
||||
inkscape:cy="247.16912"
|
||||
inkscape:document-units="px"
|
||||
inkscape:current-layer="layer1"
|
||||
showgrid="false"
|
||||
fit-margin-top="10"
|
||||
fit-margin-left="10"
|
||||
fit-margin-right="10"
|
||||
fit-margin-bottom="10"
|
||||
inkscape:showpageshadow="false"
|
||||
inkscape:window-width="1418"
|
||||
inkscape:window-height="855"
|
||||
inkscape:window-x="424"
|
||||
inkscape:window-y="590"
|
||||
inkscape:window-maximized="0" />
|
||||
<metadata
|
||||
id="metadata7">
|
||||
<rdf:RDF>
|
||||
<cc:Work
|
||||
rdf:about="">
|
||||
<dc:format>image/svg+xml</dc:format>
|
||||
<dc:type
|
||||
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
|
||||
<dc:title></dc:title>
|
||||
</cc:Work>
|
||||
</rdf:RDF>
|
||||
</metadata>
|
||||
<g
|
||||
inkscape:label="Layer 1"
|
||||
inkscape:groupmode="layer"
|
||||
id="layer1"
|
||||
transform="translate(-81.656231,-11.7557)">
|
||||
<g
|
||||
id="g2995"
|
||||
transform="matrix(0.66925035,0,0,0.66925035,371.3471,-72.927844)"
|
||||
style="fill:white;fill-opacity:1;stroke:none;fill-rule:nonzero">
|
||||
<path
|
||||
style="fill:white;fill-opacity:1;stroke:none;fill-rule:nonzero"
|
||||
d="m 166.06342,857.36804 c -2.0241,-1.63901 -2.11292,-2.89269 -2.98911,-42.18649 -1.56775,-70.30787 -3.12503,-148.81192 -3.94749,-198.99728 -0.74743,-45.6073 -0.92521,-48.94732 -2.9808,-56 -8.92469,-30.62035 -34.68288,-56.26535 -93.79792,-93.38574 -71.4521403,-44.86728 -217.86949,-119.37839 -308.62723,-157.05897 -11.53416,-4.78873 -14.07545,-5.52908 -15.12259,-4.40564 -0.95964,1.02956 -1.65295,20.23647 -2.91842,80.85035 -0.91287,43.725 -2.11692,81.49904 -2.67566,83.94232 -4.76367,20.83065 -32.50574,59.96134 -61.53114,86.79078 -22.87237,21.14193 -43.26077,35.03351 -52.17813,35.55142 l -3.71013,0.21548 -0.59028,-5.5 c -0.7529,-7.01532 6.55125,-231.1601 8.09781,-248.5 1.54288,-17.29859 4.40736,-33.86113 7.10175,-41.06252 2.60264,-6.9562 13.58837,-23.48911 31.94188,-48.07076 16.29143,-21.81981 31.85794,-37.75226 58.44884,-59.82286 30.66053,-25.44841 34.3329,-27.45527 50.34292,-27.51121 12.67088,-0.0443 25.74008,2.76304 48.65708,10.45172 79.57398,26.69719 271.10729,122.71606 363.96686,182.4627 53.1755,34.21358 78.51413,59.37766 87.39716,86.79513 2.37747,7.33804 5.6679,26.42936 7.11089,41.2578 1.13125,11.62495 8.05544,216.85126 8.19865,243 0.0845,15.42373 -0.0729,16.89815 -2.41221,22.60399 -11.11776,27.11712 -47.59735,68.13655 -82.76135,93.06091 -11.85316,8.40156 -21.59148,13.91534 -27.71765,15.69357 -4.78422,1.38871 -5.39093,1.37419 -7.30373,-0.1747 z M -53.75396,623.06914 c -16.11333,-1.99066 -30.39323,-10.66862 -38.76393,-23.55704 -5.77741,-8.89551 -8.7432,-19.27201 -8.81115,-30.82783 -0.0945,-16.06423 4.45371,-26.8127 16.30168,-38.52498 12.04616,-11.9082 24.23682,-16.62772 40.61216,-15.72271 26.10197,1.44258 45.6435897,18.04702 51.0008797,43.33525 2.75772,13.01736 1.11109,24.63774 -5.19616,36.66971 -10.56115,20.14689 -32.3266697,31.44641 -55.1434797,28.6276 z"
|
||||
id="path2999"
|
||||
inkscape:connector-curvature="0" />
|
||||
</g>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 3.9 KiB |
17
docs/docs/index.md
Normal file
17
docs/docs/index.md
Normal file
@ -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.
|
||||
10
docs/docs/user_manual/installation.md
Normal file
10
docs/docs/user_manual/installation.md
Normal file
@ -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.
|
||||
|
||||
<iframe width="750" height="350" src="https://www.youtube.com/embed/FoUua_Jlmpc?rel=0" frameborder="0"
|
||||
gesture="media" allow="encrypted-media" allowfullscreen></iframe>
|
||||
6
docs/docs/user_manual/introduction.md
Normal file
6
docs/docs/user_manual/introduction.md
Normal file
@ -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.
|
||||
41
docs/mkdocs.yml
Normal file
41
docs/mkdocs.yml
Normal file
@ -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
|
||||
@ -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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user