Commit Graph

46 Commits

Author SHA1 Message Date
Patrice Chalin fbe6ad6498 Update CONTRIBUTING.md
Signed-off-by: Patrice Chalin <chalin@users.noreply.github.com>
2022-07-15 10:24:37 -04:00
blam c86c0019ea chore: updating contributing
Signed-off-by: blam <ben@blam.sh>
2022-06-30 13:49:22 +02:00
Chris Nitsas 192858f503 Fix link "bugs" in CONTRIBUTING.md
The link used to point to [GitHub label "bugs"](https://github.com/backstage/backstage/labels/bugs) which doesn't exist. The [correct label is "bug"](https://github.com/backstage/backstage/labels/bug).

Signed-off-by: Chris Nitsas <nitsas.chris@gmail.com>
2022-05-02 21:00:46 +03:00
Patrik Oldsberg 4b83c98165 update docs mentioning vale
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-27 18:48:50 +02:00
Patrik Oldsberg abc0e755eb microsite: replace stability index with versioning policy
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-03-02 19:07:01 +01:00
Saksham Sharma 5c58400dfe Fix a typo in CONTRIBUTING.md
Signed-off-by: Saksham Sharma <sakshamsharma630@gmail.com>
2022-02-22 15:33:03 +05:30
Saksham Sharma e7d2599d35 Update the docs
Signed-off-by: Saksham Sharma <sakshamsharma630@gmail.com>
2022-02-22 15:33:03 +05:30
Daniel Clayton a9bede36e1 docs(plugins): add GH OAuth to github-actions docs
In order for GitHub Actions plugin to work, the GitHub OAuth application must be created at the organization level. Updated docs to assist others that may run into any issues related to this.

Signed-off-by: Daniel Clayton <dclayton@godaddy.com>
2022-01-21 12:47:16 -07:00
Patrik Oldsberg ab31a2c286 updated release process to not release new packages immediately
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-11-20 14:58:57 +01:00
Johan Haals 4130394b79 Update link wording
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-10-08 15:09:30 +02:00
Johan Haals 888b970498 Add docs for writing changesets
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-10-07 14:48:25 +02:00
Bodil Björklund fb71c7e682 Add section explaining how to add sign-off-by line using GitHub desktop
To facilitate for non-terminal users, add information about how to add the signed-off-by line to your commit message (and amend it) when using GitHub Desktop

Signed-off-by: Bodil Björklund <bodilb@spotify.com>
2021-09-23 15:07:25 +02:00
Patrik Oldsberg 6fe1651cb6 Update CONTRIBUTING.md to clarify use of minor and patch changes
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-08-05 17:16:42 +02:00
Himanshu Mishra b6cb9dcc28 dco/docs: email in angular braces
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-05-10 15:36:52 +02:00
Himanshu Mishra 14d6f407a5 chore: document useful git commands to avoid any DCO trouble
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-03-06 21:51:12 +01:00
Johan Haals 9d8515ba68 Merge pull request #4513 from backstage/leemills83/dco
Adding DCO file and updating contributing.md with details
2021-03-01 14:24:55 +01:00
Patrik Oldsberg 328d301b81 Update CONTRIBUTING.md 2021-03-01 09:50:37 +01:00
Juan Lulkin 69c64ac7f3 Merge remote-tracking branch 'upstream/master' 2021-02-21 00:03:29 +01:00
Juan Lulkin 203ca79f23 Replaces links to repo with relative ones to please CI 2021-02-20 19:50:00 +01:00
blam 687ddc49d7 chore: reworking the title of the docs to avoid confusion 2021-02-12 23:50:03 +01:00
blam cbf4566ed6 docs: rework the getting started documentation for both contributors and integraters are seperated 2021-02-12 23:31:55 +01:00
Lee Mills ed0e1a306f Adding DCO file and updating contributing.md with details 2021-02-12 16:04:43 +01:00
Adam Harvey 8061a1e844 Add ref to EditorConfig 2020-12-29 01:10:25 -05:00
Adam Harvey 51fb9702af Tweak when 2020-12-22 21:23:58 -05:00
Adam Harvey ae5e7b4b12 Clarity on stability index input 2020-12-22 21:22:22 -05:00
Adam Harvey 854cfaa821 Add more context for contributors 2020-12-22 21:18:13 -05:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Adam Harvey 01876a713a Fix typo (#2888) 2020-10-14 07:26:19 +02:00
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
Mayurs 17c30eaf3e fix(docs): Fix typos in several .md files (#2627) 2020-09-27 18:57:20 +02:00
Fredrik Adelöw 56b82f523d chore: add contrib to CONTRIBUTING.md (#2585) 2020-09-24 07:55:54 +02:00
Taras Mankovski 8ae216a29e Update CONTRIBUTING.md
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net>
2020-09-16 18:15:03 -04:00
Taras Mankovski b22320e6c7 Add changeset instructions to CONTRIBUTING.md 2020-09-16 15:54:06 -04:00
Himanshu Mishra 51b94bd82c Remove duplicate instructions from contributing guide 2020-09-11 10:47:02 +02:00
Stefan Ålund ee0310213c Tweaks to plugin marketplace (#2209)
* Tweaks to plugin marketplace

* Add plugin details to roadmap

* Update README.md

* Link to plugins from home

* Update circleci.yaml
2020-09-01 14:27:33 +02:00
Patrik Oldsberg 7c4307d1ee docs: update storybook url 2020-08-14 09:20:09 +02:00
Ivan Shmidt 9b439375cf Merge branch 'master' of github.com:spotify/backstage into mob/docusaurus-structure 2020-08-12 16:04:54 +02:00
Ivan Shmidt 882728ae1d feat: the whole docs structure
Co-authored-by: Raghunandan Balachandran <meetraghu28@gmail.com>
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 15:20:20 +02:00
Patrik Oldsberg 4bc9a33a3c docs: split getting started section in readme into create-app vs clone
Co-authored-by: Ben Lambert <ben@blam.sh>
2020-08-12 14:19:22 +02:00
Patrik Oldsberg d1b2a6ccd1 Add coding guidelines to CONTRIBUTING 2020-07-29 11:12:52 +02:00
Stefan Ålund ce30c43d24 [Docs] Fix relative paths to code (#1662)
* [Docs] Fix relative paths to code

* Update create-a-plugin.md

* Link to existing plugins

* Update README.md

* Update README.md

* Review edits
2020-07-16 09:17:43 +02:00
Stefan Ålund 86e399221c Link to SECURITY in CONTRIBUTING 2020-06-12 08:43:57 +02:00
Adil Alimbetov f72d97dc17 Sidebar logo update (#814)
* Testing logo ux

* Updated logo on sidebar

* removed unused vars

* adjusted types on icon components
2020-05-27 10:13:41 +02:00
Remy DeCausemaker 5ffabfe2bb Update CONTRIBUTING.md (#929) 2020-05-19 21:59:29 +02:00
Stefan Ålund 151417a9ed Document how to suggest new plugins (#590)
* Document how to suggest new plugins

* Update plugin_template.md

* Update ux-component_template.md

* Update plugin_template.md
2020-04-18 18:00:15 +02:00
Stefan Ålund eb76a4d05a Add CONTRIBUTING (#572)
* Add CONTRIBUTING

* Update CONTRIBUTING.md

* Fixed review comments

* Typo
2020-04-17 10:53:11 +02:00