Skip to content
Snippets Groups Projects
Commit 3e2bd5a4 authored by Heather McNamee's avatar Heather McNamee
Browse files

add numbers on steps, add points about improving documentation

parent e96c153b
No related branches found
No related tags found
No related merge requests found
## Write for GitLab
 
Find out more about how you can [Write for GitLab](https://about.gitlab.com/community/writers/).
 
The posts themselves are published in the [Gitlab.com project](https://gitlab.com/gitlab-com/www-gitlab-com)
There the blog posts are drafted, commented on and merged.
 
### View the backlog of issues
We aim to improve documentation through this program and add we will add tutorials to
documentation which can live on and continue to be maintained as part of
docs.
### Step 1 - Get ideas. Review the backlog of issues
 
* [View High priority issues](https://gitlab.com/gitlab-com/blog-posts/issues?label_name=High+priority)
* High level [Technical overviews](https://gitlab.com/gitlab-com/blog-posts/issues?label_name=Technical+overview) which explain the "why" behind something and how it all works.
Loading
Loading
@@ -18,22 +21,38 @@ As well as topics related to the people behind the projects, collaboration, etc.
* [Open source](https://gitlab.com/gitlab-com/blog-posts/issues?label_name=Open+source)
* [Community](https://gitlab.com/gitlab-com/blog-posts/issues?label_name=Community)
 
### Apply
#### Who's working on what?
- When an issue is assigned, that means it's being worked on. You will be assigned an issue to write.
- If an issue IS assigned, then it means it's being worked on.
- If it's not assigned, then it's open for proposal
### Step 2 - Apply
 
Submit your application to the program: [Write for GitLab](https://about.gitlab.com/community/writers/).
 
### Who's working on what?
### Step 3 - Propose!
 
- When an issue is assigned, that means it's being worked on. You will be assigned an issue to write.
- If an issue IS assigned, then it means it's being worked on. If it's not assigned, then it's open for proposal
Before you start writing, we need to work on your proposal
- Objective: What is the purpose of the article or tutorial?
What value does it offer the reader?
What can they do after reading the article?
- Outline: Write an outline of the main headings from the article
We'll then get a reviewer to give you feedback on the proposal.
This will also give us a chance to see where we might add to documentation.
 
### Write!
### Step 4 - Write!
 
Your post will get submitted into the www-gitlab-com using GitLab workflow.
 
Here's how it works.
 
1. Create a fork of our website project. [www-gitlab-com](https://gitlab.com/gitlab-com/www-gitlab-com).
- If your project also includes CE or EE documentation improvements, you can work
on those in parallel.
2. Add a post
- You'll write your blog post in Markdown.
- Follow examples under [/source/_posts](https://gitlab.com/gitlab-com/www-gitlab-com/tree/master/source/_posts)
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment