# Contribution Workflow for Writers \[Technical & Non-Technical]

***

## General Information about projects

{% content-ref url="/spaces/D4inNwzMBU3WuBySeYcV" %}
[Collabocate OSC Projects: Overview](https://resources.collabocate.community/projects-overview/)
{% endcontent-ref %}

***

## Making and submitting changes for documentation projects

See tabs below for the different methods/mediums you can use to edit technical or non-technical writing and documentation projects.

{% tabs %}
{% tab title="Option 1: GitBook" %}
***Request access to GitBook***

Our community and project documentation reside on GitBook. Request access to GitBook from the ***@community-coordinator***, so that you can be given editor access.

***

***Edit and submit change requests***

* Locate the documentation project you want to contribute to on GitBook
* Click on the ***edit button*** on the top right corner of the document
* Make desired changes to the pages as needed
* Once satisfied/done, click on ***request review*** button. Reviewer(s) will check out your changes, approve or request you to fix things in your submission as required.
  {% endtab %}

{% tab title="Option 2: GitHub" %}
***GitHub repository for documentation projects***

Our GitBook community and project docs are synced to one GitHub repository, so that you can find them and edit them on GitHub too.

GitHub repository link: <https://github.com/collabocate-osc/docs>

***

***Engineering workflow: Git branch name & technical writing***

If you are submitting via GitHub, use the naming convention for branch names from the Engineering contribution workflow. The Engineering workflow documentation is also helpful to finding project repos and local development setup, in the case of technical writing.

{% content-ref url="/spaces/uGDfGtsUTaBkuk5DjT56" %}
[Engineering](https://resources.collabocate.community/software-engineering/)
{% endcontent-ref %}

***

***Edit and submit pull requests***

See the guidelines for submitting pull requests to any of our GitHub repositories in the page below.

{% content-ref url="/spaces/kz0h3jWUEnMa4Mjjkort" %}
[Pull Request Guidelines](https://resources.collabocate.community/pull-request-guidelines/)
{% endcontent-ref %}
{% endtab %}
{% endtabs %}

***

## Video and Image dimensions

If the issue ticket you are taking on involves videos or images, the videos and images that you submit should have these dimensions:

* **Video dimension:** 1280 x 720
* **Image dimensions:** preferably 1280 x 720, but this can change depending on the needs of the doc or markdown involved.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://resources.collabocate.community/writing/contribution-workflow.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.