mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-29 09:47:50 +08:00
111 lines
3.5 KiB
Markdown
111 lines
3.5 KiB
Markdown
---
|
|
layout: editable
|
|
title: Contribution Guidelines
|
|
---
|
|
|
|
This document explains how to contribute changes to the *IntelliJ SDK Platform Documentation* project.
|
|
|
|
## Licensing
|
|
Project source code terms of use, reproduction, and redistribution is defined by
|
|
[Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html)
|
|
|
|
## Contributing Changes
|
|
|
|
### Users with Write Access
|
|
To contribute your changes
|
|
[clone the project](https://help.github.com/articles/fetching-a-remote/),
|
|
implement your changes, and
|
|
[push](https://help.github.com/articles/pushing-to-a-remote/) them to the repository.
|
|
|
|
|
|
### Users with Read-Only Access
|
|
|
|
To contribute you changes use a
|
|
[pull request](https://help.github.com/articles/using-pull-requests/).
|
|
[Creating a pull request](https://help.github.com/articles/creating-a-pull-request/)
|
|
article on GitHub explains how to do it.
|
|
|
|
## Setting Up Environment
|
|
To build and run the project locally you need to set up its development environment,
|
|
Refer to the
|
|
[README](https://github.com/JetBrains/intellij-sdk-docs/blob/master/README.md)
|
|
section of this project.
|
|
|
|
## Project Structure
|
|
The project contain the following major types of content:
|
|
|
|
1. Articles
|
|
An article describes some part of the API and general rule of using it in a free form.
|
|
2. Step-by-step tutorials
|
|
3. Code samples
|
|
|
|
|
|
### Markup
|
|
|
|
Documents are written in
|
|
[Markdown](https://en.wikipedia.org/wiki/Markdown)
|
|
markup template language.
|
|
Processing of Markdown source code and conversion into HTML is made by
|
|
[Kramdown](http://kramdown.gettalong.org/syntax.html) library.
|
|
|
|
|
|
### Creating an Article
|
|
|
|
To post an article, create a Markdown document inside of the project directory structure.
|
|
Jekyll engine will process all the Markdown files inside the project and create corresponding static HTML pages with same relative paths for them.
|
|
To process a Markdown file you need to refer to it's HTML counterpart in *\_SUMMARY.md*
|
|
|
|
### Table of Contents and \_SUMMARY.md
|
|
|
|
File
|
|
[\_SUMMARY.md](https://github.com/JetBrains/intellij-sdk-docs/blob/master/_SUMMARY.md)
|
|
located in the root directory defines project's hierarchical structure displayed on the left side of the page in a tree form.
|
|
Place the name of an article and a link relatively to the site root to the corresponding HTML document to *\_SUMMARY.md* to list the article in TOC.
|
|
Headers without links to corresponding files won't be visible. Files not included in the listing wont be processed.
|
|
|
|
### Formatting Rules
|
|
|
|
### Text
|
|
To make the source code easy to read, start every new sentence from a new line.
|
|
Avoid semicolons, long sentences, and complicated formulations.
|
|
|
|
### Links
|
|
Place every link separately on a new line
|
|
|
|
```
|
|
Please refer to the
|
|
[following article](http://link.address)
|
|
to get more information
|
|
```
|
|
|
|
|
|
## Project Structure
|
|
|
|
All the documentation is logically divided into three major parts:
|
|
|
|
* **Basics**
|
|
Contains information required to get familiar with the plugin development environment and the API
|
|
* **Architecture Reference Guide**
|
|
More in-depth API description
|
|
* **Tutorials**
|
|
Series of steps and code samples that show how parts of the API can be use in practice
|
|
|
|
Your article should be placed in one of these three categories dependently on the type of the content.
|
|
|
|
|
|
### Child Documents
|
|
|
|
To place child documents, create a subdirectory named like a parent article and place all the child documents in it.
|
|
|
|
|
|
### Images
|
|
|
|
To place images for an article, in the article's directory root create a subfolder named \<article_name\>/img.
|
|
Please downscale screenshots made at high resolution.
|
|
|
|
|
|
|
|
|
|
|
|
|