Contributing¶

Thank you for contributing! We have tried to organize the site such that we can include a variety of content.

Overview¶

You can suggest comprehensive changes to the website using GitHub.
1. Check out the official Contributing Explainer
If you have never used GitHub, don’t worry. There’s a little bit of setup, but you can do everything from the website.
Try to follow the Contributing Guidelines as much as possible, but it’s okay to skim this section for now.
Once approved, your content will be merged and immediately visible.

Contributing Guidelines¶

We want the site to be helpful, comprehensive, and easy to navigate. As such, there are a few guidelines we would like contributions to follow:

The Code of Conduct applies to all submissions.
Contributions must be centred around virtual production.
Your contribution must fit into one of the existing categories:

Adding Workflows¶

Workflows should reference a series of Guides to be placed in sources/guides.
Workflows must include a Production Checklist banner. See BURN Workflow. Insert after your title:
```
.. prodcheck::
    :4k: yes|no
    :timecode: yes|no
    :raw: yes|no
    :aces: yes|no
    :ndisplay: yes|no
    :live: yes|no
    :multicam: yes|no
```
Choose yes or no for each option. This produces something like:

Production Checklist

4K

RAW

Timecode

ACES

Live

Multicam

nDisplay

✅

❌

✅

❌

✅

❌

✅

Important your workflow does not need to check all boxes.

Adding Guides¶

If workflows are recipes, then guides are ingredients. While workflows can be seasoned to taste a guide is more all-or-nothing.

Try to keep the following in mind:

Guides must be part of a workflow. If you have a general tip, consider adding a Help page instead.
A guide must be complete before it will be published.
Please follow the Referencing Content, Adding Media, and Embedding Content guidelines.
Guides should link to pre-requisites, next steps, or alternative approaches. Keep your guide sizes reasonable.

Guide Template¶

You can copy-paste the following into your new guide

:author: YOUR NAME
:author_url: YOUR LINK
:date: THE DATE

================
YOUR GUIDE TITLE
================

.. deps:deps::

.. deps:lesson::

   IN TWO SENTENCES DESCRIBE THIS GUIDES OBJECTIVE

ANY PARAGRAPH, SECTION, ETC CONTENT

For any pre-requisites add

.. deps:dep:: DEP TITLE

   DESCRIBE THE DEP :goto:`guides/GUIDE-NAME`.

If the guide does not exist, add a placeholder file at source/guides/GUIDE-NAME.rst

================
GUIDE NAME TITLE
================

.. milestone::

This will automatically track the guide in our backlog. For next steps, use .. deps:next:: NEXT TITLE similar to above.

Adding Media¶

Images must:
1. be hosted from vpifg.com by adding them to the repository, or
2. be hosted on one of:
  - https://postimages.org/
  - https://cubeupload.com/
Images hosted on external sites might be copied to vpifg at any time. You must own the copyright to the image, or be allowed to license it.

Adding Help¶

Sometimes content doesn’t fit into a guide, but it is helpful nonetheless. The guidelines for what goes and help our a little looser than what goes into a workflow or a guide. Still, we prefer help articles that:

are centered around a virtual production
address a specific technical hurdle
are short and to the point
include diagrams, images, and videos

Each Help article should be its own document in sources/help.

Referencing Content¶

External links must be Citations.
1. Refer to to the citation from your guide or workflow as follows:
```
Use the [unrealengine]_ to ...
```
2. Add the citation, either in the same document, or in References as:
```
.. [unrealengine] The unreal game engine `<https://www.unrealengine.com>`_
```
3. Keep in mind, your citation might be relocated to References.
Exceptions
1. Studio pages (Studios) may use external links, including affiliate links.
2. About pages may use external links.

Using citations keeps things under control, and ensures that all links are reusable and relevant.

Embedding Content¶

Embedding content, such as videos, figures, slides is encouraged and permitted. The content must be served from one of the following domains:

youtube.com
docs.google.com
figma.com

If you would like to add another domain, please open an issue to discuss.

Adding Studios¶

Feel free to add your studio to Studios.

All content must follow our Code of Conduct.
Limit to a single page in source/studios.
You are encouraged to:
1. Link to your website.
2. Advertise any virtual production services.
3. List your equipment, and even include affiliate links. Be specific if you can, including model numbers.
4. Describe your vision for virtual production.
5. Include photos of your studio.
Fore everything above, it should be limited to virtual production.
There are no size minimums. A home setup is just as good as a large studio.