78e1866688
Merge pull request #4894 from tudi2d/4825-techdocs-breadcrumbs
2021-03-15 12:30:41 +01:00
50be5c09aa
Add rootRouteRef to test app options to fix component tests
...
Signed-off-by: tudi2d <phugenroth@googlemail.com >
2021-03-12 15:30:39 +01:00
634577d887
Change hardcoded docs link to use route reference
...
- Specify Changelog
Signed-off-by: tudi2d <phugenroth@googlemail.com >
2021-03-12 14:54:45 +01:00
5bf51c3db2
Change link to static /docs
...
Signed-off-by: tudi2d <phugenroth@googlemail.com >
2021-03-12 14:54:41 +01:00
c8b54c3702
TechDocs Homepage ( #4401 )
...
* add tabs to homepage
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add new overview content component
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add new owned content component
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add types
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add test for owned content component
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add test for overview content
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* document name to link and change copy to clipboard link
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add changeset
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* rename changeset file
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* fix types
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* move home components out from reader dir to its own dir
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* Update plugins/techdocs/src/reader/components/OverviewContent.tsx
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net >
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* enable search in table
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add docs icon to core icons
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add example TechDocs support button config
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* use isOwnerOff and useOwnUser to see documents that are owned via group membership
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* update tests
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* cleanup imports
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* leave techdocs support config out of this PR
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* prettieeeeeer
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* copy paste useOwnUser hook over to techdocs plugin
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* add changeset
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
* delete unused package
Signed-off-by: Emma Indal <emma.indahl@gmail.com >
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net >
2021-03-11 19:23:32 +01:00
702b837b8b
Remove all dot-folder imports everywhere
...
We aren't supposed to import from '.' or '../..' etc; point to the actual node being imported instead. I did allow e.g. '../../bigfolder' however. Going all the way to the individual file could be done too, but is a matter of taste perhaps.
Also ran Organize Imports on all the touched files :)
No changeset since there are no functional changes at all - only the imports changed
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-03-10 13:43:59 +01:00
d661bece6a
Merge pull request #4675 from egnwd/techdocs/header-links
2021-03-08 13:21:43 +00:00
2089de76be
ItemCard: deprecate and replace with composable pieces
...
Signed-off-by: Fredrik Adelöw <freben@gmail.com >
2021-03-04 19:27:24 +01:00
83883a2ea3
Update plugins/techdocs/src/reader/components/TechDocsPageHeader.tsx
...
Co-authored-by: Adam Harvey <adam.harvey@dxc.com >
Signed-off-by: Elliot Greenwood <hello@elliotgreenwood.co.uk >
2021-03-02 16:50:05 +00:00
52b5bc3e27
Remove credentials from xhr request. Add techdocs-backend changeset
2021-03-01 12:45:18 +01:00
74534a0f8c
Move auth token to contrib
2021-03-01 12:29:59 +01:00
afebbadd34
use token instead of idToken
2021-03-01 12:29:59 +01:00
813c6a4f20
add authorization to techdocs api requests
2021-03-01 12:29:58 +01:00
04b2ecd23c
Add link to owner from the techdocs header
...
Signed-off-by: Elliot Greenwood <hello@elliotgreenwood.co.uk >
2021-02-23 23:56:23 +00:00
9a03faa997
Add namespace to the component links in the techdocs header
...
Signed-off-by: Elliot Greenwood <hello@elliotgreenwood.co.uk >
2021-02-23 23:56:23 +00:00
6f90b912fc
Merge branch 'master' of github.com:backstage/backstage into improve-errors
2021-02-08 11:48:19 -05:00
d84cb8199d
Switch to CodeSnippet component
2021-02-08 10:54:48 -05:00
59b1b04f0b
Merge pull request #4314 from adamdmharvey/techdocs-error500
...
techdocs: Expose backend 500 errors (mkdocs build) to UI
2021-02-05 12:26:52 -05:00
fd933c4239
Add comment TODO
2021-02-05 10:50:11 -05:00
41af18227f
techdocs: migrate to new composability API
2021-02-04 20:22:50 +01:00
e73f35b1ea
Wrap in code fence
2021-02-03 21:46:54 -05:00
5fa3bdb553
Add support for links in ItemCard and fix height of cards with tags vs cards without tags
2021-02-03 09:37:52 +01:00
2b9d16b397
Add period for consistency in error msg
2021-02-02 23:32:06 -05:00
5479e4eef0
Improve display of errors
2021-02-02 23:27:20 -05:00
1df7721a68
TechDocs: Fix test with invalid hook call error
2021-02-02 13:52:47 +01:00
4ddf8d5e27
TechDocs: Fix frontend tests due to async apiOrigin function
2021-02-02 13:52:47 +01:00
e44925723e
TechDocs: Make requestUrl and storageUrl optional configs by using discovery APIs
...
closes #3715
Co-authored-by: Himanshu Mishra <himanshu@orkohunter.net >
2021-02-02 13:51:04 +01:00
96dbdfbb41
Update error message
2021-01-31 22:02:25 -05:00
45de779d5f
Add changeset
2021-01-29 16:20:07 -05:00
cb61bc8cbb
Hardcode file not found status
2021-01-29 16:16:14 -05:00
877f46c177
Support custom status codes
2021-01-29 16:15:34 -05:00
c677643afa
Rename from @backstage/plugin-catalog-common-react to @backstage/plugin-catalog-react
2021-01-29 10:54:09 +01:00
019fe39a08
Createa @backstage/plugin-catalog-common-react package
2021-01-29 10:54:09 +01:00
a5e27d5c1d
Introduce techdocs metadata in techdocs-common
...
* Add TechdocsMetadata type in backend plugin endpoint
* Introduce TechDocsMetadata type in frontend
* Add changeset
* Remove old thennable metadata resp
* Address PR feedback
- Remove explicit type annotation on TechDocsMetadata
- Reintroduce res.send instead of throwing an error
- Change logger info to logger error
* Add TechDocsMetadata type in frontend plugin
* Commit yarn.lock
* Introduce JSON5 and remove parsing in local pub
Signed-off-by: Matei David <matei.david.35@gmail.com >
2021-01-16 18:33:53 +00:00
a6f9dca0dc
plugins should not depend on core-api
2021-01-14 08:54:54 +01:00
99a778ac9f
Use history.pushState for hash link navigation in techdocs
2021-01-13 23:21:34 +01:00
9d08ef8f46
techdocs: replace 'build' with 'generate' in most places
2020-12-09 16:01:29 +01:00
9bd130a73a
techdocs: Use 'local' and 'external' for alternatives for techdocs.builder config
...
Co-authored-by: freben <freben@gmail.com >
2020-12-09 12:31:40 +01:00
8736de114a
Merge remote-tracking branch 'origin/master' into orkohunter/techdocs-publish-to-cloud-storage
2020-12-08 08:12:38 +01:00
87a33d2fe8
[TechDocs] Bug fixes and cleanups ( #3599 )
...
* Fixed issue with some internal doc links reloading the page and removed modifyCss transformer
* Create silly-kiwis-rest.md
* Formatting in changeset
2020-12-07 16:49:24 +01:00
a212e43142
techdocs: Add JSON Schema config
...
Show better error if techdocs.builder is set to 'ci' and if no docs are found.
Return 404 from googleStorage client when a file is not found.
2020-12-05 10:48:54 +01:00
11340fb2f6
techdocs: Remove spinners
...
Spinners cause unnecessary UX distraction.
Case 1 (when docs are built and are to be served): Spinners appear for a split second before the name of site shows up. This unnecessarily distracts eyes because spinners increase the size of the Header. A dot (.) would do fine. Definitely more can be done.
Case 2 (when docs are being generated): There is already a linear progress bar (which is recommended in Storybook). Spinners are not good. 🤷
2020-12-04 22:09:38 +01:00
85af34ffd5
techdocs: Use EntityName from catalog-model as Entity type
2020-11-28 20:02:40 +01:00
dbca620ff9
Use fs-extra and async file read method
2020-11-26 20:41:40 +01:00
266e93b478
TechDocs: Refactor metadata retrieval
...
1. Don't use mkdocs in name of APIs or variables. It is an implementation detail and liable to change in future.
2. techDocsApi.getMetadata('mkdocs') and techDocsAPI.getMetadata('entity') should be two separate functions just because their responses differ in structure. They should also be type checked.
3. Use either 'techdocs' or 'TechDocs' consistently. 'techDocs' seems like an unnecessary third way to write TechDocs, which can be avoided.
4. Remove unused /plugins/techdocs-backend/src/service/metadata.ts file
2020-11-25 19:39:48 +01:00
8fd5e64351
TechDocs: Tell users when index.md is missing (better error message) ( #3429 )
...
* TechDocs: Logger already prints the name of plugin
* TechDocs: Display a custom error message if provided
* TechDocs: throw custom error message if index.md is not present
* Language improvements. Thanks @freben
Co-authored-by: Fredrik Adelöw <freben@gmail.com >
Co-authored-by: Fredrik Adelöw <freben@gmail.com >
2020-11-25 09:52:19 +01:00
1d55b1e976
Merge pull request #3336 from backstage/mob/techdocs-storage-solutions-spec
2020-11-24 14:30:42 +01:00
8fc3fc9629
TechDocs: Document basic and recommended architecture
2020-11-23 17:41:58 +01:00
717e43de14
catalog-client: change entities interface, add fields support ( #3296 )
2020-11-18 19:58:36 +01:00
42b0dbddcb
feat(catalog-client): create a basic catalog client ( #3166 )
2020-11-04 13:18:03 +01:00
Himanshu Mishra