mirror/elk
1
0
Fork 0
mirror of https://github.com/elk-zone/elk synced 2024-11-23 22:56:09 +09:00
Code
5b1ad44875
elk/docs/README.md

4.1 KiB
Raw Blame History

Welcome to the Elk Docs

The documentation site publishes to https://docs.elk.zone. We use Docus as the site generator and deploy through Netlify.

Quickstart

Prerequisites

  • Github account
  • Git installed on your machine
  • Node >14.18 installed
    • Use node -v to see which version you have installed.
    • Use nvm install node to upgrade to the latest version.
    • Refer to the nvm docs for information on installing nvm.
  • pnpm installed

Install and Preview

  1. Fork the Elk Github project into your own account
  2. Clone your fork to your local machine
  3. From your terminal, cd to the directory you cloned into
  4. cd docs to enter the docs folder
  5. Run npm install Note: Run this from the project's docs folder, not the root of the repository on your machine!
  6. Run npm run dev to launch a preview
  7. Visit localhost:3000/docs/ to see a live preview of the docs

Contributing

When you are ready to submit work back to the main Elk repo, create a PR.

  1. If it has been a bit, synchronize your fork with the upstream repo on Github.
  2. Do your work in a branch on your fork Use git checkout -b branchNameToUse to create a working branch separate from main.
  3. Do your work in your preferred editor
  4. Commit changes often and write meaningful commits
  5. Push the changes from your local machine to your fork on Github
  6. Go to your fork of the Elk project in your Github account
  7. Select the Pull Request tab
  8. Select New Pull Request
  9. Confirm the repo/branches to compare
  • Base repo should be elk-zone/elk
  • base branch should be main
  • Head repository should be your fork
  • Compare branch should be your working branch you want to submit If you don't see four drop downs, be sure you are comparing across forks.
  1. Add a description of the changes your request makes
  2. Select Add Pull Request

Other team members will review your PR and make comments or suggestions through the PR. You can continue making additional changes and/or apply feedback by making additional commits to the branch on your fork. ALWAYS WORK IN YOUR FORK/BRANCH.

Writing

Tips

  • Docs are in the docs/content folder
  • Write in standard markdown
  • Refer to the Docus writing pages guide
  • Docus provides additional components to extend basic markdown

Avoid screenshots until Elk reaches a stable release.

Standards

Write in American English using spelling as found in Merriam Webster. Translation and localization will be handled separately as/when availability or necessity allow.

Use semantic linefeeds with no more than one sentence per line. To create paragraphs, use a blank line.

There are no house style rules currently. When we add any, they will be found in this document.

Style Guides

Use the first guide that mentions a usable standard from the order below:

  1. Refer to the U.S. Government's Federal Plain Language Guidelines as a base standard.
  2. For user interface, device, and other technical guidance, refer to Google's Developer Style Guide.
  3. As a secondary reference to the Google guide, refer to Microsoft's Style Guide, then the Chicago Manual of Style, 17th Edition.

We use Merriam-Webster as the standard dictionary for spelling.

Images

Place image files in the /docs/public/images folder. You can create subfolders to organize the images.

To add an image to a doc, use standard markdown:

[![Label](/docs/images/image.svg)](URL.for.hyperlink)
[![StackBlitz](/docs/images/stackblitz.svg)](https://stackblitz.com/)

In-house Styles

None yet defined