Commit Graph

166 Commits

Author SHA1 Message Date
Patrik Oldsberg 5ff5b1325d Merge pull request #2739 from Marvin9/feat/flexible-theme-for-page
feat: theme customization for pages
2020-10-16 12:47:05 +02:00
Marvin9 8f0608a5ed chore: refactor 2020-10-15 09:16:39 +05:30
Eric Nilsson 08f5e0311f TechDocsPageHeader: Changed repo location icon (#2895) 2020-10-14 11:03:41 +02:00
blam 46960a61ec v0.1.1-alpha.25 2020-10-12 22:42:54 +02:00
Marvin9 6e3ba7c2c4 chore: resolve conflicts 2020-10-11 19:19:35 +05:30
Marvin9 6d68f6fec1 feat: consume theme provided by Page theme provider 2020-10-11 19:14:23 +05:30
Stefan Ålund 8d666e43bd Use MissingAnnotationEmptyState for plugins (#2824) 2020-10-09 15:11:15 +02:00
Himanshu Mishra c852e7b09d Merge pull request #2812 from spotify/sebastianq/techdocs-new-component-url
[TechDocs] Use new url scheme for techdocs
2020-10-09 10:41:47 +02:00
Mahmood Hosseini 4295a248e9 feat(techdocs-header): Show breadcrumbs on docs page (#2786) 2020-10-08 23:26:41 +02:00
Sebastian Qvarfordt ae499a55ff Use new url scheme for techdocs 2020-10-08 16:59:30 +02:00
Sebastian Qvarfordt 29ec8c2f09 TechDocs: Fix reload when clicking internal docs pages (#2784)
* Check to see if links start with window.location.origin to see if we should handle it as a internal docs link

* Fixed failing test

* Fix lint issues
2020-10-08 11:26:46 +02:00
Marvin9 7db0ffb6e5 feat: add rel to <a> & few <Link> tags 2020-10-06 21:19:31 +05:30
Patrik Oldsberg 46b71700ee v0.1.1-alpha.24 2020-10-05 15:45:33 +02:00
Marvin9 e2564645e5 feat: Replace old page theme props with new ones 2020-10-04 18:03:50 +05:30
Emma Indal 497675538c TechDocs: browse metadata (#2682)
* feat(techdocs): TechDocsPageWrapper to take in labels prop and use TechDocsHeader component

* feat(techdocs): new TechDocsHeader component as wrapper around Header from core

* feat(techdocs): TechDocsPage metadata

* feat(techdocs): TechDocsMetadata class responsible for reading metadata from generated techdocs metadata json file

* fix(techdocs): delete TechDocsPageWrapper component

* fix(app-config): delete /docs from request url

* feat(techdocs): TechDocsHeader with labels to browse metadata

* fix(techdocs): move metadata to backend plugin

* feat(techdocs-backend): introduce two new metadata routes

* feat(techdocs): new techdocs api to be responsible to request metadata from backend

* feat(techdocs): register new api for plugin

* fix(techdocs): reader to take in onReady prop

* fix(techdocs): TechDocsHome component to use its own header

* fix(techdocs): TechDocsPage responsible to get metadata and pass it down to the TechDocsHeader

* fix(techdocs): component tests for both TechDocsHeader and TechDocsPage

* fix(techdocs): adjust api to use /docs in url since it was taken away in requestURL

* fix(tests): move assertion into act

* fix(techdocs): rename TechDocsHeader to TechDocsPageHeader

* fix(techdocs): rename TechDocsHeader to TechDocsPageHeader

* fix(techdocs-backend): add some logs

* Update plugins/techdocs/src/reader/components/TechDocsPage.test.tsx

* delete unused import
2020-10-01 10:12:24 +02:00
Navaneeth Suresh e85030902f Add a message if techdocs takes long time to load 2020-09-26 21:49:49 +05:30
blam f326c2ee1e Merge branch 'master' of github.com:spotify/backstage into feat/backend-plugin
* 'master' of github.com:spotify/backstage: (30 commits)
  fix(techdocs-core): use the content of the readme as long description for the pypi package (#2578)
  chore: add contrib to CONTRIBUTING.md (#2585)
  Fix typo (#2584)
  backend-common: default config env to development
  v0.1.1-alpha.23
  TechDocs: Inject CSS transformer and initial backstage style integration for reader (#2560)
  bug(gql): use import to import the graphql module
  Rename file
  [blog] Announce CNCF Sandbox (#2568)
  document cleaning - tutorial quickstarts (#2520)
  Simplify codecov flag names
  chore(scaffolder-backend): typo in visibility
  Kubernetes plugins boilerplate (#2559)
  CHANGELOG: add entry for SessionApi refactor
  Upload package specific code coverage to codecov
  Add codecov flags for core and core-api packages
  TechDocs: Enable allowVulnerableTags in sanitize-html (#2554)
  chore: trust the Boolean :)
  docs: regenerate api reference docs
  core: refactor SessionStateApi to SessionApi with sign-in/out
  ...
2020-09-24 10:54:04 +02:00
blam 37a4a3afd0 chore(deps): updating dependencies for plugin 2020-09-24 10:52:26 +02:00
Patrik Oldsberg b5e6051959 Merge pull request #2577 from spotify/blam/new-release
Release v0.1.1-alpha.23
2020-09-23 18:22:40 +02:00
blam 6c55d38348 v0.1.1-alpha.23 2020-09-23 16:40:49 +02:00
Sebastian Qvarfordt 19e34b5319 TechDocs: Inject CSS transformer and initial backstage style integration for reader (#2560)
* Inject CSS transformer and initial backstage style integration for reader

* Update plugins/techdocs/src/reader/transformers/injectCss.test.ts

Co-authored-by: Emma Indal <emmai@spotify.com>

* Fix test name and run injectCss in preTransformer

* Fix for invisible links in reader

* Added missing semi-colon

* Better styling on codeblocks

Co-authored-by: Emma Indal <emmai@spotify.com>
2020-09-23 16:40:18 +02:00
Sebastian Qvarfordt 999ff914af TechDocs: Enable allowVulnerableTags in sanitize-html (#2554)
* enable allowVulnerableTags in sanitize-html

* Fixed lint issue

* Removed style tag from allowed list. Seems to work fine.

* Added tests to make sure we keep link tags and remove style tags
2020-09-22 14:22:52 +02:00
blam 6f70008386 chore(cli): fixing issues with the new dependency 2020-09-21 23:37:35 +02:00
Raghunandan 72235dd51e v0.1.1-alpha.22 2020-09-18 15:14:38 +02:00
Emma Indal 296b6376e3 fix unclickable external links (#2396) 2020-09-10 12:05:22 +02:00
Sebastian Qvarfordt d865f88344 [TechDocs] Rebuild docs if the github source is newer than last docs build (#2353)
* Added age check for documentation in github to make sure it's up to date

* Updated failing tests

* Updated docs to explain requestUrl and storageUrl

* Updated failing tests

* Update packages/create-app/templates/default-app/app-config.yaml.hbs

* Update docs/features/techdocs/getting-started.md

Co-authored-by: Emma Indal <emmai@spotify.com>
2020-09-09 16:05:28 +02:00
Fredrik Adelöw 0a24df743f chore: bump mui to the create-app resolved version, to lose Accordion warnings 2020-09-09 11:18:18 +02:00
alandovskis f88d8873a8 Display Warning if TechDocs Annotation is Missing (#2319)
* Display warning if TechDocs annotation is missing.

* TechDocs: Add link to Getting Started when annotation is missing.
2020-09-09 08:52:36 +02:00
Patrik Oldsberg 38b6703102 core-api: change ApiFactory.implements to .api 2020-09-08 11:31:48 +02:00
Patrik Oldsberg e7c04aedab dev-utils: remove separate ApiTestRegistry setup 2020-09-08 11:31:47 +02:00
Patrik Oldsberg aa235dd154 app: move api factories out to plugins 2020-09-08 11:31:47 +02:00
Emma Indal 969cf48858 [TechDocs] migrate techdocs to use new routing/catalog api (#2312)
* migrate techdocs to use new routing

* use new techdocs routing in default app

* new EntityPageDocs and Router components

* remove unused code

* remove unused import
2020-09-07 16:56:03 +02:00
Patrik Oldsberg b045b166b6 run prettier 2020-09-05 16:37:30 +02:00
Emma Indal 3b545791ce new release 31 aug 20 2020-09-01 14:10:22 +02:00
Emma Indal 3fbfb42619 register techdocs storage api to dev app (#2139) 2020-08-27 14:01:09 +02:00
Sebastian Qvarfordt 0b2f787699 Updated docs for techdocs plugin (#2127)
* Updated docs for techdocs plugin

* Error in example comment

* Update plugins/techdocs/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update plugins/techdocs/src/reader/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update plugins/techdocs/src/reader/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update plugins/techdocs/src/reader/README.md

Co-authored-by: Emma Indal <emmai@spotify.com>

* Update link to transformers doc to point to reader doc for now

Co-authored-by: Emma Indal <emmai@spotify.com>
2020-08-27 09:52:49 +02:00
Raghunandan 734dcca107 Release v0.1.1-alpha.20 2020-08-26 11:33:14 +02:00
Raghunandan 15e334a584 Release v0.1.1-alpha.19 2020-08-21 11:40:04 +02:00
Sebastian Qvarfordt 5bf548ac80 Show progress bar when loading on techdocs (#2065) 2020-08-21 10:31:30 +02:00
Sebastian Qvarfordt 13908d69c2 TechDocs: Access entity techdocs from service catalog (#1835)
* feature(techdocs): JIT generation of techdocs

* Fix linting issues

* Add Techdocs tab to entity page

* Added missing dep

* Added missing dep

* Removed duplicate dep

* Better tab navigation

* Update label on entity page to say docs

* Fix lint issue

* Move building of docs from entity to a function

* feature(techdocs): JIT generation of techdocs

* Fix linting issues

* Add Techdocs tab to entity page

* Added missing dep

* Added missing dep

* Removed duplicate dep

* Better tab navigation

* Update label on entity page to say docs

* Fix lint issue

* Move building of docs from entity to a function

* attempt to add back react as a dep

* Fixed failing test

* fix(techdocs): Hopefully fixed tests

* Fixed another failing test

* Initial apiRef for techdocs storage

* Cleaned up some code in reader

* test(headertabs): add tests to HeaderTabs component

* fix(headertabs): change tab mock id

* fix(techdocs-generator): fix problem with macOS symlink to tmp folder

* fix(lint): remove unused configApiRef

* wip

* Ongoing cleanups

* Cleanups and fix tests

* WIP cleanups

* Clean up some things

* Clean up some things

* Added missing notice header

* ts issue fixed

* Add show contition to api tab

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Co-authored-by: Emma Indal <emmai@spotify.com>
2020-08-20 14:06:09 +02:00
Patrik Oldsberg f69a2804ae docs: fix broken links 2020-08-11 12:21:15 +02:00
Patrik Oldsberg f8c696e038 v0.1.1-alpha.18 2020-08-07 17:08:28 +02:00
Patrik Oldsberg 0dd8fa2828 v0.1.1-alpha.17 2020-08-05 19:36:36 +02:00
dependabot-preview[bot] 14cfeb390e chore(deps): bump react-use from 14.2.0 to 15.3.3
This is a copy of #1731 with fixes
2020-08-03 14:33:35 +02:00
Sebastian Qvarfordt fe4430907a Merge pull request #1787 from DavidJSykes/Fix-TechDocs-missing
Fix tech docs missing #1750
2020-07-30 19:32:45 +02:00
David J Sykes cc905069d1 Changed optional parameter name to allow for more generic uses 2020-07-30 16:57:38 +01:00
David Sykes 58fa8ce5fb Updated test 2020-07-30 11:35:01 +01:00
David Sykes 4f54f062fe Updated test 2020-07-30 11:31:26 +01:00
David Sykes ea57820c62 Removed a div that was no longer needed 2020-07-30 11:30:01 +01:00
David Sykes fa708d6572 TechDocsNotFound now uses ErrorPage from core with an optional docPath parameter 2020-07-30 11:19:12 +01:00