Commit Graph

62 Commits

Author SHA1 Message Date
blam 979bcccf23 chore: fixing last of the typescripts 2021-01-21 20:06:49 +01:00
Alan Crosswell 82ca95e375 minor editorial suggestions from @freben and @adamdmharvey 2021-01-19 09:50:10 -05:00
Alan Crosswell e019935409 prettier 2021-01-18 14:24:56 -05:00
Alan Crosswell bba8b99255 document using locally-installed cookiecutter
This avoids running Docker in Docker.

See https://github.com/backstage/backstage/blob/57460cda021bddaf04e7c3351c3881a3f24859b0/plugins/scaffolder-backend/src/scaffolder/stages/templater/cookiecutter.ts#L56-L79

See also https://backstage.io/docs/features/techdocs/getting-started#disabling-docker-in-docker-situation-optional where it is configurable.
2021-01-15 16:25:06 -05:00
Adam Harvey 14466940f7 Single line metadata and prettier ignore 2021-01-05 13:42:31 -05:00
blam 9075c4816b docs: added a note about templates should have catalog-info 2020-11-22 02:51:10 +01:00
Patrik Oldsberg 474bb5b57f rewrite other references to spotify/backstage and sorrounding things 2020-11-03 11:39:27 +01:00
Patrik Oldsberg af141c0766 rewrite repo location urls 2020-11-03 11:03:49 +01:00
Patrik Oldsberg 7c28026ae0 docs: update scaffolder-backend installation docs 2020-10-26 23:34:25 +01:00
Adam Harvey c6c54b1b3a Clarifications to software template documentation (#3070)
* Clarify scaffolders

* Tweak preparer

* Template clarifications

* Minor wording for clarity

* Change wording
2020-10-23 23:20:30 +02:00
Marvin9 f05e4b9608 re: make consistent environment variables
GITHUB_PRIVATE_TOKEN & GITHUB_ACCESS_TOKEN => GITHUB_TOKEN
GITLAB_PRIVATE_TOKEN, GITLAB_ACCESS_TOKEN & SCAFFOLDER_GITLAB_PRIVATE_TOKEN => GITLAB_TOKEN
AZURE_PRIVATE_TOKEN => AZURE_TOKEN
GHE_PRIVATE_TOKEN => GHE_TOKEN
2020-10-08 10:34:06 +05:30
Patrik Oldsberg 6775deef9b update docs and examples to use shorter config secret syntax 2020-10-04 16:51:00 +02:00
Patrik Oldsberg 238715aac2 config,docs: switch to using url location type 2020-10-03 11:55:23 +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
Mattias Frinnström 0f732731ef Restructure config for Azure DevOps scaffolder 2020-09-28 14:19:20 +02:00
Mattias Frinnström 56a9f8389b Add Azure DevOps publisher to scaffolder 2020-09-28 14:19:20 +02:00
Mattias Frinnström c109cbe4df Add Azure prepare stage to scaffolder 2020-09-28 14:19:19 +02:00
Navaneeth Suresh e7686833fd docs: fix typos in the documentation (#2633) 2020-09-28 13:18:40 +02:00
Patrik Oldsberg 521728348d backend: change the default backend plugin mount point to /api 2020-09-23 09:39:47 +02:00
Fredrik Adelöw e9b1c931b8 chore(scaffolder-backend): typo in visibility 2020-09-23 07:58:10 +02:00
Björn Marschollek 55542797a9 Add GitLab integration for scaffolder
This adds a GitLab integration for the scaffolder backend.

We're introduceing a preparer and a publisher for GitLab so that we can
read templates from GitLab and publish them to a configured GitLab
instance. The two instances don't need to be the same. For instance,
templates could be public on gitlab.com, but the created repos will live
in a hosted GitLab somewhere else.

The publisher gets its own config object in `app-config.yaml` where the
target instance and token can be specified.

The service catalogue defines both `gitlab` and `gitlab/api` as
processors. They are both handled by the same preparer.

Closes #2372
2020-09-17 12:39:05 +02:00
Tim Jacomb fcdae603ba Merge branch 'master' into add-access-support 2020-09-17 07:17:12 +01:00
Ivan Shmidt b0656e47d9 Merge pull request #2489 from iamrajiv/issue_1994
Added description header field in backstage.io docs
2020-09-16 22:29:50 +02:00
Rajiv Ranjan Singh d833cd9fe8 added description header field 2020-09-16 22:14:28 +05:30
Rajiv Ranjan Singh def4032351 added description header field 2020-09-16 21:47:19 +05:30
Tim Jacomb fd7809ea34 Merge branch 'master' into add-access-support 2020-09-16 16:02:01 +01:00
Tim Jacomb 0c7acbe3cb Update docs 2020-09-16 14:19:01 +01:00
Taras Mankovski 9ad2b8186b Clean up installation 2020-09-16 08:19:09 -04:00
Taras Mankovski 6d3ce75100 Apply requested chanegs 2020-09-15 16:32:17 -04:00
Taras Mankovski e9e3c79295 Run prettier on docs/features/software-templates/installation.md 2020-09-15 16:31:42 -04:00
Taras Mankovski a7d5ade5a1 Merge GitHub scaffolding instructions 2020-09-15 16:31:35 -04:00
Ben Lambert 0597211af1 Merge pull request #2433 from timja/support-user-or-org
scaffolder: Allow user or org, remove hard coded isOrg
2020-09-15 09:17:25 +02:00
Patrik Oldsberg 3cf20cbad7 remove mock-data scripts 2020-09-12 15:27:27 +02:00
Tim Jacomb c95fd141ae Remove hardcoded isOrg 2020-09-11 22:17:58 +01:00
Patrik Oldsberg d5585cd574 Merge pull request #2390 from spotify/rugvip/temp-docs
docs: more visible heads up about completing installation steps for templates
2020-09-10 09:55:45 +02:00
Patrik Oldsberg b9660715ef microsite: install docs 2020-09-09 20:36:47 +02:00
Patrik Oldsberg 6d178e375c docs: more visible heads up about completing installation steps for templates 2020-09-09 17:16:01 +02:00
Stefan Ålund 0a1416d476 [Docs] Clarify what is core features (#2314) 2020-09-07 19:44:17 +02:00
Patrik Oldsberg b045b166b6 run prettier 2020-09-05 16:37:30 +02:00
Patrik Oldsberg f3528c8664 Merge pull request #2208 from spotify/rugvip/rules
catalog-backend: wrap location-specific rules in an additional rules field
2020-09-01 15:10:02 +02:00
Dominik Henneke 1b658f4bc3 fix: use correct rules syntax 2020-09-01 13:32:22 +02:00
Patrik Oldsberg 6e8f4ca44a catalog-backend: wrap location-specific rules in an additional rules field 2020-09-01 11:31:07 +02:00
Patrik Oldsberg 81cb294dac config,docs: add templates as allowed kind and document process 2020-09-01 10:40:19 +02:00
Rod Machen 57c3e2ad5b update software template docs 2020-08-28 14:07:25 -05:00
Emma Indal edab8b2ad8 fix(template tags): fixes issues with tags specified with uppercase (#2049)
* fix(template tags): fixes issues with tags specified with uppercase

* adds new validator for metadata tags

* fix(template tags): change tags to be lowercase

* fix(template tags docs): update docs to include lowercased tags

* fix(validator): change back to using isValidDnsLabel for tags

* fix(software catalog docs): use lowercase tags in docs
2020-08-24 17:01:27 +02:00
Stefan Ålund c6c3c94c18 Camelcase GitHub and GitLab (#2034)
* Camelcase GitHub and GitLab

* GitLab

* Code GitLab

* GitHub in code

* Fix auth naming

* Update docs/features/software-templates/adding-templates.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

* Update docs/features/software-templates/extending/create-your-own-preparer.md

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>

Co-authored-by: Raghunandan Balachandran <soapraj@gmail.com>
2020-08-21 14:48:16 +02:00
Patrik Oldsberg b4959667af docs: fix broken links 2020-08-13 18:51:23 +02:00
Ivan Shmidt 6e8cf4651e Merge branch 'master' of github.com:spotify/backstage into mob/docusaurus-structure 2020-08-13 14:55:25 +02:00
Patrik Oldsberg 388df8c3bb docs/features: fix static location entires not being list of objects 2020-08-13 13:32:48 +02:00
Patrik Oldsberg 1991dfdfce docs/features/software-templates/installation: update TODO link 2020-08-12 17:10:33 +02:00