Commit Graph

194 Commits

Author SHA1 Message Date
Himanshu Mishra ea3d406038 Merge pull request #4714 from erdoganoksuz/feature/OpenStackSwiftPublisher 2021-03-05 07:57:36 +00:00
Adam Harvey 56b21fda18 Merge pull request #4818 from adamdmharvey/refactor-techdocs-logging
chore(techdocs-common, techdocs-backend): Refactor TechDocs logging
2021-03-04 19:23:00 -05:00
Adam Harvey a9d7c123fb Wording tweaks
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
2021-03-04 18:53:39 -05:00
Adam Harvey 2daa65a18b Change wording
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
2021-03-04 18:51:57 -05:00
Adam Harvey c149b14009 Fix typo
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
2021-03-04 18:51:34 -05:00
Adam Harvey 02d78290a5 Enhance example documented-component
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
2021-03-04 16:05:17 -05:00
Adam Harvey 26e23b2c7d Refactor logging
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
2021-03-04 14:23:01 -05:00
github-actions[bot] ff2ab4fade Version Packages 2021-03-04 13:11:10 +00:00
erdoganoksuz e0bccb16a2 versions for changeset
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:30 +03:00
erdoganoksuz cebda81000 documentation added
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:23 +03:00
erdoganoksuz e36ef00fd0 router case added and hasDocsBeenGenerated fixed
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:12 +03:00
erdoganoksuz de313a1c94 swift publisher
Signed-off-by: Mert Can Bilgiç <mert.bilgic@trendyol.com>
2021-03-03 11:46:02 +03:00
Patrik Oldsberg ae30b916df Merge pull request #4731 from erikxiv/fix/techdocs-static-url
Techdocs static docs should use external url
2021-03-01 19:26:25 +01:00
Patrik Oldsberg 570d310c90 Merge pull request #4621 from nhidtran/enhancement/4423
Enhancement/4423: remove the usage of res.send() for res.json()
2021-03-01 17:54:09 +01:00
Erik Larsson 74534a0f8c Move auth token to contrib 2021-03-01 12:29:59 +01:00
Erik Larsson f18b51d932 set and use access-token cookie 2021-03-01 12:29:59 +01:00
Erik Larsson e937c1b4f0 fix: use external url for static docs 2021-02-28 23:34:21 +01:00
github-actions[bot] 4ae0467c2f Version Packages 2021-02-23 10:31:40 +01:00
NHI TRAN ac67aab5dd PR updates
PR updates

fix failing test
2021-02-22 10:23:26 -05:00
NHI TRAN e6fe13c675 upstream master 2021-02-21 13:21:37 -05:00
NHI TRAN f43192207a enhancement: 4423 switch sending back data from server to res.json() instead of res.send()
changeset
2021-02-19 17:05:14 -05:00
Fredrik Adelöw dedee41f57 Merge pull request #4572 from backstage/freben/attr
got rid of some attr and cleaned up a bit in techdocs schema
2021-02-19 10:10:04 +01:00
github-actions[bot] 4188c2ccb4 Version Packages 2021-02-18 13:23:19 +00:00
Fredrik Adelöw f37992797a got rid of some attr and cleaned up a bit in techdocs schema 2021-02-18 11:15:18 +01:00
Himanshu Mishra b16b096f58 TechDocs: Add etag to techdocs_metadata.json 2021-02-15 19:38:07 +01:00
github-actions[bot] aa49ca2284 Version Packages 2021-02-11 10:15:47 +00:00
Himanshu Mishra b73b0fe979 techdocs: don't swallow errors other than NotModifiedError 2021-02-10 12:21:14 +01:00
Himanshu Mishra 08142b2568 TechDocs: Add changesets for deprecation and proper caching 2021-02-10 11:02:40 +01:00
Himanshu Mishra f8a4a30fb0 TechDocs: Update tests for proper url preparer caching 2021-02-10 11:02:40 +01:00
Himanshu Mishra 50fcdc48b4 TechDocs: Warn when using legacy git preparer and dir preparer in backstage.io/techdocs-ref
Context: https://github.com/backstage/backstage/issues/4409
2021-02-10 11:02:40 +01:00
Himanshu Mishra 057af3cac0 TechDocs: Implement etag based caching for git preparer
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-10 11:02:40 +01:00
Himanshu Mishra 97a9a7365f TechDocs: Implement etag based caching for url preparer
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2021-02-10 11:02:38 +01:00
Himanshu Mishra 66944ec7bf TechDocs: Preparers will take and return an etag for cache invalidation 2021-02-10 11:01:18 +01:00
Fredrik Adelöw 5a51635197 backend-common: implement UrlReader.search that does glob matching 2021-02-09 12:16:12 +01:00
github-actions[bot] 6794967d20 Version Packages 2021-02-04 13:02:30 +00:00
Himanshu Mishra 93a53ea093 TechDocs: Use @deprecated for techdocs config urls 2021-02-02 23:16:09 +01:00
Himanshu Mishra 38469b66bf techdocs: fix tests by reusing the instantiated discovery 2021-02-02 13:51:05 +01:00
Parth Shandilya 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
Himanshu Mishra 8eb862c58e Merge pull request #4017 from viavarejo/feature/techdocs-azure-storage 2021-01-31 16:03:24 +01:00
vitorgrenzel 59b8d5a0d9 feat(techdocs-common): add Azure Blob Storage 2021-01-28 16:16:22 -03:00
vitorgrenzel c777df180a feat(techdocs-common): add Azure Storage 2021-01-28 16:16:21 -03:00
Himanshu Mishra 03a2d95c71 TechDocs: Update tests with mock url reader 2021-01-28 15:32:09 +01:00
github-actions[bot] cda741034d Version Packages 2021-01-28 10:46:08 +00:00
github-actions[bot] c5584b62c2 Version Packages 2021-01-21 13:13:05 +00:00
Matei David 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
Himanshu Mishra e2030972fc Merge pull request #4062 from backstage/orkohunter/use-urlreader-in-techdocs 2021-01-15 13:12:45 +01:00
github-actions[bot] be332e13ea Version Packages 2021-01-14 13:05:31 +00:00
Himanshu Mishra dc33c51890 TechDocs: Use URL Reader in the out-of-the-box experience
It is time to start using URL Reader for the exmaple docs components we provide in the out-of-the-box experience (i.e. when users experience TechDocs by doing a git clone of this repository).

URL Reader makes the prepare step 8x faster.
2021-01-13 21:38:26 +01:00
Himanshu Mishra cb7af51e73 techdocs: cache docs site when built using urlReader for 30 minutes
This caching makes it usable experience, so that docs are not built on every load.
In future readTree will support a method to fetch the timestamp of the latest HEAD. And
it should be used to invalidate the cache.
2021-01-13 21:09:44 +01:00
Himanshu Mishra 2165901c00 TechDocs: Generator now requires input and output directory and does not create them
The creation of temporary directories and their clean up should be handled on its own. techdocs-cli already has a fixed input output dir requirement. It makes that generator accepts these values as requirements.
2021-01-11 22:33:10 +01:00