Official repository for Couchbase documentation
HTML JavaScript CSS C Shell Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
content-archived
content
dita
layouts
lib
static
.gitignore
.ruby-version
GA_blurb.txt
Gemfile
Gemfile.lock
Procfile
README.md
Rules
convert_docs.sh
docs_all_new.html
docs_main_new.html
nanoc.yaml
new_docs_pageFINAL.txt
pull_publish.sh
unknown_tags.txt
using_docs_ng.markdown

README.md

docs-ng is the official Couchbase documentation repository.

DO NOT CREATE BRANCHES IN THIS REPO

Please DO NOT create branches in this repository. If you want to contribute, create your own fork, as described below under How to Contribute Code.

About

This is a project to build a static documentation website for Couchbase.

Showstoppers/Blockers

  • Something better than Google Custom search or alternate page separatation/anchors, especially for jump-links. (Marty - investigating)

General Requirements/Features

  • Breadcrumb navigation - phase 2
  • PDF/Print Stylesheet - phase 2
  • Add corporate website headers, footers, etc to docs initial landing page (Karen - done)
  • Improve left navigation. Items at end disappear when multiple sub-menus are open. (Volker - DONE)
  • Short-term mobile hack -toggle open and close of left navigation to support mobile. (Volker)
  • Longer term mobile layout.
  • Input/improvements popout hooked up to CBugg (Dustin)
  • Parser/conversions from SDK comments to Markdown (Sergey Ruby and C)
  • Anything else you can think of to make this a great user and authoring experience.
  • Make repo public, or at minimum add support as contributors.
  • Provide longer pages with jump links to subsections

How to Contribute Code

  1. Fork it and clone (git clone git@github.com:USERNAME/punch_stuff.git)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

How to Run Locally

Make sure you have Bundler,

gem install bundler

Install the dependencies,

bundle install

And run the generator and server with Foreman

foreman start

The site will be available at http://localhost:3000/

Resources

Internal Staging site at docs.pub.couchbase.com External Site

How to Contribute Content

Intro

Welcome to the new static website for Couchbase TechPubs. To create content, you can author all your information in Markdown. If you need a new guide, contact TechPubs so we can discuss and agree upon any new folders and naming. TechPubs will set up your initial folder as well as add it to site navigation.

Staging Site and Production Site

The Staging server is setup to get and produce content in stage branch of docs-ng. There is a second copy of the repo that will produce and publish the master branch of docs-ng to the public system at S3.

Source Control

The entire new site as well as new content are in a public GitHub repo you can branch:

  • To edit content, branch this repo make your changes to existing files: Github Repo for docs-ng

  • Then git checkout stage to work on the staging server-only content

  • To check the branch you are on use git branch
  • Commit your changes, git add and git commit
  • Push change to staging repo: git push
  • When you areready, send a pull request so your changes can be merged and published

  • Tech Pubs will elevate any content from the stage repo to the master repo, resolving any merge conflicts if needed:

    git checkout stage
    git pull #make sure stage repo up to date
    git checkout master
    git pull #make sure mater repo up to date
    git merge stage #to merge staged changes to master branch
    git push #to push to master
    

New Guides and New Major Versions

TechPubs will set up your new folder for new guides or new major versions, for example this_guide_name-X.X. TechPubs will also set up the YAML file to include menu options and navigation to your guide. Follow these guidelines once your file is set up:

  • Create .markdown files for each chapter in your guide.
  • Create an index.erb file at the root of the content folder. In this file add an include statement for each .markdown chapter, for instance:

    <%= include_item 'couchbase-devguide-2.0/couchbase-developer-s-guide-2.0' %>

  • In your guide folder, keep all your images in a file called images.

Adding and Editing Content

Follow the spec set down by John Gruber for Markdown

There are other options supported by Multi-Markdown which we also support, most importantly tables. For information on creating tables, see Markdown Cheatsheet

In general you can use any editor of your choice, with the preference that it includes some automatic spell- and grammar- checking.

After you are done making your changes, make sure you make a pull request so they are picked up in the master repo and published on the staging server.

Previewing and Publishing Content

To preview your content locally, in the docs-ng repo convert your Markdown to HTML:

nanoc

Then you can preview it:

nanoc view

Open your web browser to localhost:3000/guide_name/

When you content is ready to stage, commit it and send a pull request to have it added to the master branch in GitHub. This will get picked up by the staging server automatically.

How to Convert on Docs Staging

  1. Manually:

    cd /home/docs/docs-ng  
    ./pull_publish.sh  
    
  2. Automatically

    The ./pull_publish.sh is running automatically as a cron job every 60 minutes and will pull from git, convert with nanoc.