Commit Graph

319 Commits

Author SHA1 Message Date
Paul Schultz 040b54f7e5 clean up formatting
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-08 10:13:38 -06:00
Paul Schultz 34fe6c9246 Merge branch 'master' into update-codeblocks 2023-03-08 10:07:11 -06:00
Patrik Oldsberg 0240f7b22a Merge pull request #16708 from backstage/rugvip/redirects
microsite-next: redirects for new index pages + fix links
2023-03-06 13:21:52 +01:00
Patrik Oldsberg e5a9031eae microsite-next: redirects for new index pages + fix links
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-03-06 11:46:11 +01:00
blam 6b8ca73179 chore: small tweaks for getting involved
Signed-off-by: blam <ben@blam.sh>
2023-03-03 10:29:30 +01:00
blam d0864ef9eb chore: fixing broken links
Signed-off-by: blam <ben@blam.sh>
2023-03-02 19:06:30 +01:00
blam ca4cdda557 chore: links between docs
Signed-off-by: blam <ben@blam.sh>
2023-03-02 15:36:05 +01:00
Paul Schultz 9c95f91c0a Add titles to codeblocks and switch from diff codeblock to language codeblock
Signed-off-by: Paul Schultz <pschultz@pobox.com>
2023-03-01 13:30:38 -06:00
blam f79bafb844 chore: fix doscird links
Signed-off-by: blam <ben@blam.sh>
2023-02-23 10:37:57 +01:00
Johan Haals 7a23cdfa59 Update image links to use markdown syntax
Co-authored-by: Ben Lambert <ben@blam.sh>
Co-authored-by: Fredrik Adelöw <freben@users.noreply.github.com>
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2023-02-21 11:43:14 +01:00
Jan Van Bruggen c51efce2a0 Update docs to always use yarn add --cwd for app & backend
Some commands currently error, and others are simply formatted inconsistently.
This format seems to work and be the most popular/common,
so I applied it to all similar occurrences.

Signed-off-by: Jan Van Bruggen <JanVB@verily.com>
2023-02-13 09:40:20 -07:00
Adam Harvey 9050e4389e chore(docs): Improve plugin example
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2023-01-23 22:47:48 -05:00
Adam Harvey 923296999b fix(docs): Errant dash in a sentence
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2023-01-04 14:29:03 -05:00
Fredrik Adelöw 09d54f4e08 Merge pull request #15107 from SayakMukhopadhyay/master
fix: remove deprecated `create-plugin` script
2022-12-28 16:19:34 +01:00
Peter Macdonald 368a4d6bdf Udated the getting-started docs only as advised
Signed-off-by: Peter Macdonald <macdonald.peter90@gmail.com>
2022-12-27 12:14:14 +01:00
Sayak Mukhopadhyay 1c0fc5a6c2 feat: update docs where create-plugin is used with new --select plugin
Signed-off-by: Sayak Mukhopadhyay <mukhopadhyaysayak@gmail.com>
2022-12-21 19:03:40 +05:30
Fredrik Adelöw 342b8c23eb Merge pull request #14999 from TheMonolithX64/fix-backstage-update-docs-cli-links
docs: Update broken links to cli docs
2022-12-20 09:45:51 +01:00
Fredrik Adelöw 5b0701ea1b Merge pull request #15187 from Mike-Dunton/patch-1
Documentation Fix node-postgres config options URL
2022-12-13 23:04:22 +01:00
Johan Haals dbe6b9308d Fix docs for microsite-next
Signed-off-by: Johan Haals <johan.haals@gmail.com>
2022-12-13 14:31:10 +01:00
Michael Dunton 2d4f7f0a15 Fix Node-Postgres config options URL
While following along with the getting started documentation, I wanted to change the user provided to the connection string. When using the link in the comment it took my to a 404 page. I found the correct link. 

Signed-off-by: Michael Dunton <Mike-Dunton@users.noreply.github.com>
2022-12-12 14:46:25 -05:00
TheMonolithX64 b5e3da44c4 Update broken links to cli docs
Signed-off-by: TheMonolithX64 <admin@monolithicgames.com>
2022-12-02 17:42:20 +00:00
Johan Haals 6ac88843de Merge pull request #14877 from amritpalnagrame/patch-1
Fix: nesting level in homepage documentation
2022-11-28 13:45:40 +01:00
Amritpal Nagra 9f365bab3b Fix: nesting level in homepage documentation
Signed-off-by: Amritpal Nagra <amritpalnagrame@gmail.com>
2022-11-28 12:08:11 +05:30
Kurt King da15e9a561 reorganize commands
Signed-off-by: Kurt King <kurtaking@gmail.com>
2022-11-22 19:26:02 -06:00
Kurt King c477117b84 add cd command to documentation
Signed-off-by: Kurt King <kurtaking@gmail.com>
2022-11-22 19:21:42 -06:00
Andre Wanlin 6db37424c5 Changes to make Vale happy, I hope
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-11-18 12:43:34 -06:00
Andre Wanlin 9d2c6a7db4 Removed from create-app and added to docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-11-18 12:25:50 -06:00
Patrik Oldsberg a531879958 docs/getting-started: clarify yarn version
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-11-17 14:03:01 +01:00
Priit Liivak 2500d440a6 Update running-backstage-locally.md
https url is more accessible for environments, where github authentication has not been set up.

Signed-off-by: Priit Liivak <priitliivak@gmail.com>
2022-11-15 15:43:49 +02:00
Patrik Oldsberg 5e7bdb0109 update docs to match new build script + fixes
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-11-15 11:04:19 +01:00
Patrik Oldsberg 7605c11cda bump Node.js to 16 & 18
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-11-07 11:39:08 +01:00
Matthew Boyle 502ebe7d24 update the configuration steps of the docs
Signed-off-by: Matthew Boyle <matt-boyle@hotmail.co.uk>
2022-10-26 08:06:16 +01:00
Fredrik Adelöw cbe11d1e23 just getting rid of vale warnings
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-10-22 17:18:47 +02:00
Andre Wanlin e65f18e0a2 Removed database step from docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-10-12 15:35:03 -05:00
Leena 36405bd80d fix(docs): import SignInProviderConfig - not used
SignInProviderConfig appears to be a superfluous import - flagged as imported but never used.

Signed-off-by: Leena <19555355+sploschee@users.noreply.github.com>
2022-09-20 19:43:44 +01:00
Leena fc4d638296 @backstage/docs: fix dead link Active LTS Releases
was `https://nodejs.org/en/about/releases/`
now `https://nodejs.org/en/blog/release/`

Signed-off-by: Leena <19555355+sploschee@users.noreply.github.com>
2022-09-17 19:20:26 +01:00
Tyler Davis 5abfbc3051 Small typo fix in Theme docs
Signed-off-by: Tyler Davis <tylerd@canva.com>
2022-09-07 11:29:16 +10:00
Patrik Oldsberg 4652e6757f docs: update yarnrc reference in project structure
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-08-31 15:50:10 +02:00
Andre Wanlin 0094d8ae94 Refactor icon section based on recent changes
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-08-17 14:08:09 -05:00
Andre Wanlin f8287e5340 Added UserSettingsAvailableIconsTable and related documentation
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
2022-08-17 13:59:20 -05:00
Paulo Peixoto cfb4a12c68 fix: change HeaderIcon for ExampleIcon.
Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-10 11:47:33 -03:00
Paulo Peixoto 168bb7acdc Update app-custhome-theme.md
After suggestions @jhaals

Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-10 08:05:44 -03:00
Paulo Peixoto cdea98f2a1 Adjustments based on @awanlin suggestion.
Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-05 08:59:47 -03:00
Paulo Peixoto 8da380b0ae Update app-cusom-theme.md
Added documentation for using custom icons.

Signed-off-by: Paulo Peixoto <72894267+padupe@users.noreply.github.com>
2022-08-04 11:10:00 -03:00
blam c333ffd2c3 chore: prettify! 🪄
Signed-off-by: blam <ben@blam.sh>
2022-07-28 11:13:42 +02:00
Damola Obaleke 8d43d374fb Update app-custom-theme.md
Updating syntax in doc for clean up of Theme object

Signed-off-by: Damola Obaleke <45045727+damolaobaleke@users.noreply.github.com>
2022-07-27 11:06:26 -07:00
Erik Price f61d7714aa Fix typo
Replace "Linux-based" with "Unix-based".

Signed-off-by: Erik Price <mail@erikprice.com>
2022-06-24 11:56:41 -04:00
Adam Harvey d821a2eec3 Fix minor possessive typo
Signed-off-by: Adam Harvey <adaharve@cisco.com>
2022-06-21 23:08:41 -04:00
Himanshu Mishra b86062d778 Merge pull request #11924 from backstage/orkohunter/sign-in-resolver
docs: Add missing sign in resolver step in getting started
2022-06-21 16:48:19 +02:00
Tate 3bc59fa19f Remove undefined container className property
the `container` property is not  defined in the example  snippet and causes an error when the home page renders as the snippet was written.

I removed the className property to fix the issue.

Signed-off-by: Tate Hanawalt <tate@tatehanawalt.com>
2022-06-09 23:35:25 -04:00