search

SumoLogic / sumologic-documentation

Open Source repo for Sumo Logic documentation.
MIT License
34 stars 199 forks source link
documentation open-source react

readme

GitHub Actions status PRs Welcome Twitter Follow RSS Follow

Share your knowledge with the Sumo Logic community by contributing to our docs! You can contribute by creating an issue or pull request (PR) on our GitHub repository. We welcome all types of contributions; from minor typo fixes to new topics.

Documentation staff members review issues and pull requests on a regular basis. We do our best to address all issues as soon as possible, but working through the backlog takes time. We appreciate your patience.

Contributing Content

For detailed instructions, including our style guide, see Contributor Guidelines.

We recommend forking our repo, creating a new branch for your content changes, and submitting a pull request. We will help review, test, and merge the content for publishing.

Building Locally

Docusaurus requires the following to build on locals:

The site includes translations into other languages. To build on your local:

  1. Clone the repo using Git or tools like GitHub Desktop.
  2. In a terminal, change to the cloned repo folder. Run the install command: yarn install.
  3. To serve and review your content, use one of the following:
    • Use start, hot reloads as you make changes: yarn start. Any issues with broken links and images are listed according to file. Locate and update those issues, then run build and start again to verify.
    • Use npm serve to test and review multi-languages: npm run serve. This build does not hot reload and requires a rebuild to test and review.
  4. To build locally and test your links, run yarn build.

The static files are generated in the build folder and run on your local machine at: http://localhost:3000/. To stop the build or served site, hit Ctrl + C to interrupt. You can enter new commands in terminal, rebuild, and restart.

Sumo Docs was created using Docusaurus 2 with React, Rehype, and Remark plugin support. Our CLA bot was built using cla-bot.

Publishing Content

As pull requests are merged to the main branch by the Sumo Logic Doc team, the content builds and deploys to a staging site. This allows you to review and test your content thoroughly on a server, rather than a local build, prior to merging your code to production.