Getting Started Writing Guides
Guides are intended to fill in the gaps between our documentation and real world usage by providing concise, code-snippet-heavy content that answer specific technical questions.
You can think of them as glorified gists or less shitty and more curated Stack Overflow articles.
So you wanna write a guide? Holla! That's great because it's not very hard!
What is a guide?
On the highest level, a guide should answer a very specific technical question such as the following:
How do I run Drupal 4.6 using Lando?
This differs from the other documentation which is declarative and reads more like a technical manual and our blog which is for higher level, less technical content like case studies which are not Lando specific.
Good guides should have the following:
- Address only one hyper-specific thing
- Be short and concise, like a glorified gist
- Revolve around code snippets, config or commands
- Show up as the first Google result
- Have complete and working source code in a repo
Titles for some good guides are shown below:
- Running Drupal 4.6 in Lando
- Using Patternlab and Lando
- Getting a Lando proxy URL for the SOLR 7 web UI
- Setting up a custom Chromedriver service in Lando
And titles for some things that might be better as blog posts or general documentation are as follows:
- 10 Reasons Lando is the Best Thing Ever
- Saving time and money with Lando
- Drupal 9 Lando Recipe
- Lando Tooling
What do I need to get started?
You will need to go through all the steps in our Getting Involved section if you have not done so already. This will get you rolling for contribution. All the steps from the aforementioned section for completeness are shown below:
- Install Lando from source and activate secret toggle
- Add yourself as a contributor
- Proceed to adding your first guide
If you are having issues with any of the above or need some guidance from one of our guide pros, make sure you join our Slack org and check out the #community and/or #guiders channels.
What should I write?
If you do not have a specific guide in mind, you can always check to see if there are any GitHub issues that have been tagged
guide. These issues are generally questions submitted by end users who are unsure how to do a specific thing in Lando.
You should also feel free to add any of your own guide ideas over here. Note that you will want to select "Question" as the issue type.