Mayursinh Sarvaiya 5c6a0356c0 feat: TechDocs - Add vale linter to check words quality in md files. (#2631)
* fix(docs): typos which were reflacted from vale linter's command

* feat: Implement Vale linter (#2031)
Initialize .vale.ini file
Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules
Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt
Add steps to github workflow 'master' to check docs quality

* chore: Separate workflow for quality checking

* chore: Added 'shx' dev dependency to support grep command in cross platform

* feat: Add script to operate same quality check process on different platform

* ignore: remove lint:docs from lint-stages which was added for experiment purpose

* fix: check-all-files on push event & check-changed-files on pull_request event

* chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request

* fix: use spawnSync to solve 'The command line is too long.' error

* fix: github workflow syntax

* fix: prettier error

* chore: add vale command directly to lint-staged

* chore: use shebang for easy access

* fix: windows script issue & remove shebang

* chore: Add shebang flag

* chore: better error message related to vale

* chore: mention vale linter in documentation

* fix: spelling errors & add keywords to vocab.txt
2020-10-02 07:20:47 +02:00
2020-04-01 16:42:20 +02:00
2020-09-16 15:07:08 +02:00
2020-03-23 14:44:23 +01:00
2020-09-07 11:14:56 +02:00
2020-06-25 21:18:54 +02:00
2020-09-02 18:13:25 +08:00
2020-09-05 16:37:30 +02:00
2020-09-23 16:40:49 +02:00
2020-09-10 14:48:47 +02:00
2020-09-04 21:20:21 +08:00

headline

Backstage

License Discord Code style Codecov

What is Backstage?

Backstage is an open platform for building developer portals. Powered by a centralized service catalog, Backstage restores order to your microservices and infrastructure. So your product teams can ship high-quality code quickly — without compromising autonomy.

Backstage unifies all your infrastructure tooling, services, and documentation to create a streamlined development environment from end to end.

service-catalog

Out of the box, Backstage includes:

  • Backstage Service Catalog for managing all your software (microservices, libraries, data pipelines, websites, ML models, etc.)
  • Backstage Software Templates for quickly spinning up new projects and standardizing your tooling with your organizations best practices
  • Backstage TechDocs for making it easy to create, maintain, find, and use technical documentation, using a "docs like code" approach
  • Plus, a growing ecosystem of open source plugins that further expand Backstages customizability and functionality

For more information go to backstage.io or join our Discord chatroom.

🎉 Backstage is a CNCF Sandbox project. Read the announcement here.

Project roadmap

A detailed project roadmap, including already delivered milestones, is available here.

Getting Started

Check out the documentation on how to start using Backstage.

Documentation

Community

  • Discord chatroom - Get support or discuss the project
  • Good First Issues - Start here if you want to contribute
  • RFCs - Help shape the technical direction
  • FAQ - Frequently Asked Questions
  • Code of Conduct - This is how we roll
  • Adopters - Companies already using Backstage
  • Blog - Announcements and updates
  • Newsletter - Subscribe to our email newsletter
  • Give us a star - If you are using Backstage or think it is an interesting project, we would love a star ❤️

License

Copyright 2020 Spotify AB.

Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0

S
Description
Copy of backstage/backstage from Spotify Backstage
Readme Apache-2.0 1.3 GiB
Languages
TypeScript 93.9%
MDX 2%
JavaScript 2%
CSS 1.5%
Handlebars 0.3%