Introduction

became-a-document-writer

Clone the internal docs repository

  • Clone feedier-internal-docs from bitbucket
    • git clone git@bitbucket.org:alkaweb/feedier-internal-docs.git

Create new page

Create an entry on src/app/docs folder

  • Create a new folder with the name of your section inside src/app/docs and create the file page.md.
|- core
|- deployment
|- YOUR_NEW_SECTION
|--- page.md
|- feedback
...

Create an entry as a sub-section

  • Create a new folder with the name of your section inside src/app/docs/EXISTING_SECTION and create the file page.md.
|- core
|- EXISTING_SECTION
|--- YOUR_NEW_SECTION
|----- page.md
|--- ANOTHER_SECTION
|--- ...
|--- page.md (optional)
|- feedback
...

Update the menu

You can skip this step if you just edited an already existing page.

After creating your page you need to update the menu entry to link to your new page.

  • Go to src/lib/navigation.js.
  • Add your entry to an already existing section or create a new one.
{
  title: 'Introduction',
  links: [
  { title: 'Getting Started', href: '/' },
  { title: 'Installation', href: '/docs/introduction/installation', new: true },
  { title: 'Perform in my job', href: '/docs/introduction/perform-in-my-job' },
  { title: 'Became a document writer', href: '/docs/introduction/became-a-document-writer' },
  { title: 'NEW_PAGE_TITLE', href: 'NEW_PAGE_RELATIVE_URL' },
  ],
}...

Create the PR

Create a new branch from master, give it a meaningful name, push and create a PR on bitbucket.

You are all set, just wait for reviews now!

Previous
Perform in my job