SDK Docs Template

This repo is intended to make it easy to set up and manage an SDK documentation site for JetBrains products. It should be included as a submodule of the documentation repo, and is intended to hide as much of the scripting away from the documentation repo as possible.

Once this repo has been included in the documentation repo, the documentation repo only needs define a simple Rakefile and minimal _config.yml file, and everything else is handled automatically. Building and running the site is then as simple as:

rake preview

Structure

The idea behind this repo is to contain the compile time Rake scripts to build a documentation site. It also contains the Jekyll templates, scripts and styles to host the site at runtime. It is intended to be used as a submodule for a documentation site repo. The structure of this repo is as follows:

README.md - this file.
CONTRIBUTING-example.md - a Markdown file that contains instructions on how to contribute to a document site, including steps to build and test locally. This file is intended to be copied and modified as appropriate to the CONTRIBUTING.md file in the root repo. GitHub will automatically display this file when contributing.
bundler/Gemfile.defaults - contains the default set of gems required to build a documentation site.
bundler/Gemfile.template - contains a template Gemfile that will include and invoke the bundler/Gemfile.defaults. Intended to be used as the Gemfile in the root repo.
jekyll/config-defaults.yml.erb - template to generate the jekyll/_config-defaults.yml file which contains a default set of Jekyll config to host the documentation site. This file is used by default by the Rake scripts, with the _config.yml file in the root repo being used to override or add extra config. It is generated to correctly set file paths for Jekyll layouts, plugins and static files.
jekyll/layouts/webhelp.html - defines the layout of the main content of the page. Does not include any HTML or navigation, but sets Jekyll variables.
jekyll/plugins/markdown_converter.rb - Extends the Jekyll Kramdown Markdown converter to generate content that the webhelp template expects, such as correct attributes, call outs, etc. Also correctly handles GitHub For Markdown style codeblocks.
jekyll/plugins/static_files.rb - copies static files defines in the Jekyll config to the output site.
jekyll/plugins/to_id_filter.rb - a Jekyll Liquid filter to convert a page's URL to an ID that can be used in the page markup.
jekyll/plugins/toc_generator.rb - generates a JSON based table of contents page from the _SUMMARY.md file.
jekyll/templates/page.html - the HTML template to use to generate pages, including navigation, and incorporating the output of the webhelp.html layout file.
rakelib/gh_pages.rake - adds gh_pages Rake task to build the site and commit it to the gh_pages branch, ready for hosting in GitHub.
rakelib/sdkdocs.rake - adds tasks to bootstrap the Bundler environment, and build and/or preview the site. Will preprocess the _config-defaults.yml file, copy the page.html template (because Jekyll can't redirect templates like it can layout and plugins) and invoke Jekyll to build and/or serve the site. Can also check for dead links with the links task.
rakelib/webhelp.rake - the scripts and styles used for JetBrains webhelp sites are not in a publicly available repo. This scripts adds Rake tasks to update the compiled version of the scripts and styles from this private repo.
styles/ - extra styles that are not included in the standard webhelp setup. E.g. anchor highlighting.
webhelp/ - a precompiled copy of the standard JetBrains webhelp site scripts and styles.

How to clone and use an existing documentation site

Please see the CONTRIBUTING-example.md for instructions on building sites with this repo. (The CONTRIBUTING-example.md file is intended to be copied, edited and added to the documentation site. It contains all the information required for building a documentation site.)

How to add to a new documentation site

Please refer to the CONTRIBUTING-example.md file for details on setting up your environment, especially for setting up prerequisites.

To add the sdkdocs-template repo as a submodule for a new documentation site:

Ensure Bundler is installed - gem install bundler.
On Windows, ensure the devkitvars.bat file has been run in the current command prompt (e.g. c:\tools\DevKit\devkitvars.bat).
Add this repo as a submodule of your documentation site.
```
git submodule add https://github.com/JetBrains/sdkdocs-template.git sdkdocs-template
```
This will create a .gitmodules file in the root folder. This needs to be committed. Ensure that the sdkdocs-template folder is populated. If it isn't, run git submodule init and git submodule update.

Add a Rakefile to your documentation site. This simply includes the rake files defined in this sdkdocs-template repo, and overrides config used by the rake scripts and Jekyll. A good example is:

Rake.add_rakelib 'sdkdocs-template/rakelib'

# Override the default CONFIG here
CONFIG = {
  :source_dir => __dir__,
  :tmp_dir => "#{__dir__}/_tmp",
  :build_destination => '_site/',
  :preview_host => '0.0.0.0',
  :preview_port => 4001,
  :default_env => 'dev'
}

Run rake bootstrap to set up the Jekyll environment. This will:
- Create a Gemfile in the root directory, if it doesn't exist. The Gemfile will include sdkdocs-template/bundler/Gemfile.defaults, which lists the default gems required.
- Runs bundle install --path ~/.bundles/sdkdocs-template/_vendor/bundle, which tells Bundler to create a local copy of the gems specified in the Gemfile. The gems are installed to ~/.bundles/sdkdocs-template/_vendor/bundle.
- If you wish to add further gems, add them to the Gemfile in the root folder, and run bundle install.
Add a _config.yml file to specify config for the Jekyll site. The sdkdocs-template includes a default config file, and this one can override anything in there. You can see what other values are available for overriding by looking at sdkdocs-template/jekyll/_config-defaults.yml.erb (the file is pre-processed before being used to fix some paths). A good example of the content you need to add to the documentation site:
```
---
product_name: Foo
product_version: 1.0
product_type: Web Help

baseurl: /foo-test/
```
- The product_name field is used for the name of the product being documented, and is required. The product_version field is optional, and specifies the version of the product, and is used, together with the product name, in the title of pages. The product_type field is displayed in the page and site titles, as well as the search placeholder. The idea of the product type is to change the default of "Web Help" to e.g. "DevGuide".
- The baseurl field specifies the baseurl of the site, so that it can be hosted at a sub-folder, rather than at the root of a site. This is used to generate the full URLs of pages and links so that folders and sub-folders in the site will work correctly. If the final site is to be hosted at jetbrains.com/resharper/devguide, the baseurl should be /resharper/devguide/. It should end in a trailing slash.
Add the following to your .gitignore file:
```
_includes/
_site/
.bundle/
```
The _site folder is the generated site that is ready to be tested and deployed, and the _includes folder is unfortunately a Jekyll artifact that can't be redirected and hosted in the sdkdocs-template folder. It can be safely ignored while working on the documentation. The .bundle folder contains configuration details for Bundler, and shouldn't be committed.
Commit the new files to source control - Gemfile, Gemfile.lock, Rakefile, _config.yml and .gitmodules and sdkdocs-template.

How to build and test the site

To build and test the site, simply run rake preview. This will build the site and host it, using the config provided. The URL of the hosted site is displayed on the screen, and depends on the baseurl field defined in _config.yml.

See [CONTRIBUTING-example.md] for more details.

Submodules

This repo is supposed to be used as a submodule, and it also contains a submodule to the private webhelp-template repo (webhelp-template is the JS and CSS for the documentation site, sdkdocs-template provides scripts to make it easier to set up and maintain a documentation site using the webhelp template). The webhelp-template is currently closed source. The current plan is to make it open source, in which case, it is likely the two repos are merged.

Adding a submodule is done by something like:

```
git submodule add [email protected]:sites/webhelp-template.git webhelp-template
```

This will create a .gitmodules file, register a submodule in the webhelp-template folder, and check out the files. (Note that when a repo is added as a submodule, it doesn't get a .git folder, but instead gets a .git file that points to the location of the .git folder.

A submodule can be updated using normal git commands such as git pull. It can be switched to a different branch using git checkout, and any changes to the currently checked out revision need to be committed back into the main repo, as normal git commands. It is initially cloned at a specific revision, and not as part of a branch.update

Note that this repo currently uses the resharper-devguide branch of the webhelp-template submodule, which contains minor updates over the default webhelp template (e.g. the ability to have "placeholder" nodes in the table of contents).

isabella232 / sdkdocs-template Goto Github PK