Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: rdme docs upload #1159

Merged
merged 60 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from 59 commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
7f5c558
chore: deprecate syncDocsPath
kanadgupta Jan 16, 2025
287851f
Merge branch 'next' into kanad-2025-01-14/docs-v2
kanadgupta Jan 16, 2025
d16e754
refactor: cleaner arg definitions
kanadgupta Jan 16, 2025
2c3c60f
chore: smarter body processing
kanadgupta Jan 17, 2025
14c0dda
Merge branch 'next' into kanad-2025-01-14/docs-v2
kanadgupta Jan 17, 2025
3b97155
Merge branch 'next' into kanad-2025-01-14/docs-v2
kanadgupta Jan 28, 2025
4938972
refactor: rename readDoc to readPage
kanadgupta Jan 30, 2025
13dac09
chore: deprecation warnings for APIv1 helpers
kanadgupta Jan 30, 2025
13698e8
chore: smol type refactor
kanadgupta Jan 30, 2025
5da0de9
chore: deprecate field
kanadgupta Jan 30, 2025
4ab5015
chore: smol type improvement
kanadgupta Jan 30, 2025
e7c17db
chore: remove unused fixture
kanadgupta Jan 30, 2025
c9dec93
fix: bypass graymatter cache
kanadgupta Jan 30, 2025
a9d3a6c
refactor: move `readPage` helper function's `this`
kanadgupta Jan 30, 2025
00f9ba6
chore: remove unused snapshots
kanadgupta Jan 30, 2025
60e63f4
chore: remove a few more unused fixtures
kanadgupta Jan 31, 2025
5d3bc60
chore(migration-guide): small whitespace change
kanadgupta Jan 31, 2025
d2200f7
chore: remove more unused fixtures
kanadgupta Jan 31, 2025
d4212d6
chore: remove even more fixtures
kanadgupta Jan 31, 2025
449bc5d
docs: changelog copy tweaks
kanadgupta Jan 31, 2025
4fa875b
feat(docs): first pass at APIv2 command
kanadgupta Jan 31, 2025
a0d31b9
chore: re-indent snapshots
kanadgupta Jan 31, 2025
0b73a75
Merge branch 'next' into kanad-2025-01-14/docs-v2
kanadgupta Jan 31, 2025
6373f98
chore: fix merge conflicts
kanadgupta Jan 31, 2025
9a1e651
chore: reduce whitespace where possible
kanadgupta Jan 31, 2025
5af04ab
revert: bring back whitespace
kanadgupta Jan 31, 2025
d583078
chore: jsdoc that no longer applies
kanadgupta Jan 31, 2025
12fb5e9
chore: move fetch calls further down tree
kanadgupta Jan 31, 2025
efb49dc
refactor: move fetchSchema/fetchMappings into fetch file
kanadgupta Jan 31, 2025
a6d9bea
chore: jsdoc
kanadgupta Jan 31, 2025
79a5c5e
chore: move oasfetchmock to different file
kanadgupta Jan 31, 2025
45e0b48
test: more assertions
kanadgupta Jan 31, 2025
584c6e8
fix: copy edits, loading states
kanadgupta Jan 31, 2025
b560e7d
chore: lint
kanadgupta Jan 31, 2025
4c9f173
test: add assertion that source URL header is being sent properly
kanadgupta Jan 31, 2025
d1baed9
chore: rearrange tests
kanadgupta Jan 31, 2025
250250e
refactor: type enhancement
kanadgupta Jan 31, 2025
10f84ee
test: add dry run case
kanadgupta Jan 31, 2025
5d3aeac
test: reorg
kanadgupta Jan 31, 2025
ca7ecdd
test: dry run single failure test
kanadgupta Jan 31, 2025
e000f83
chore: reformat api errors
kanadgupta Jan 31, 2025
518a162
feat: first pass at proper error messages
kanadgupta Jan 31, 2025
ecc21ae
refactor: dry up the logging logic
kanadgupta Jan 31, 2025
d819f18
chore: remove mostly useless log
kanadgupta Jan 31, 2025
bbfccd8
chore: emoji tweaks
kanadgupta Jan 31, 2025
c871520
chore: fix tests in GHA runner
kanadgupta Jan 31, 2025
02dad35
fix: consistent error response copy
kanadgupta Jan 31, 2025
9e94c7a
test: add test for category mapping
kanadgupta Jan 31, 2025
97f22f0
refactor: use AggregateError
kanadgupta Jan 31, 2025
8153b90
chore: feedback
kanadgupta Jan 31, 2025
3389e9e
chore: frontmatter, not front matter
kanadgupta Jan 31, 2025
2d46d78
Merge branch 'next' into kanad-2025-01-14/docs-v2
kanadgupta Jan 31, 2025
c9e19fb
docs: whoops
kanadgupta Jan 31, 2025
c526181
chore: rely on top-level setup file for nock setup
kanadgupta Feb 1, 2025
61ed97f
fix: delete parentDoc if no mapping is available
kanadgupta Feb 1, 2025
ff94737
Merge branch 'next' into kanad-2025-01-14/docs-v2
kanadgupta Feb 3, 2025
cbc9004
Merge branch 'next' into kanad-2025-01-14/docs-v2
kanadgupta Feb 3, 2025
15e8c91
docs: migration guide updates for `rdme docs upload` (#1161)
kanadgupta Feb 3, 2025
9f84783
docs: autogenerate command docs
kanadgupta Feb 4, 2025
fc0cf91
chore: move tests to correct spot
kanadgupta Feb 4, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ npm run build && npm run build:docs

* [`rdme autocomplete`](documentation/commands/autocomplete.md) - Display autocomplete installation instructions.
* [`rdme changelogs`](documentation/commands/changelogs.md) - Upload Markdown files to your ReadMe project as Changelog posts.
* [`rdme docs`](documentation/commands/docs.md) - Upload Markdown files to the Guides section of your ReadMe project.
* [`rdme help`](documentation/commands/help.md) - Display help for rdme.
* [`rdme login`](documentation/commands/login.md) - Login to a ReadMe project.
* [`rdme logout`](documentation/commands/logout.md) - Logs the currently authenticated user out of ReadMe.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: This is another document title
category:
uri: /versions/stable/categories/guides/category-slug
---

Another body
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Body
8 changes: 8 additions & 0 deletions __tests__/__fixtures__/docs/mixed-docs/invalid-attributes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
category:
uri: some-category-uri
is-this-a-valid-property: nope
title: This is the document title
---

Body
6 changes: 6 additions & 0 deletions __tests__/__fixtures__/docs/mixed-docs/legacy-category.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
category: 5ae122e10fdf4e39bb34db6f
title: This is the document title
---

Body
8 changes: 8 additions & 0 deletions __tests__/__fixtures__/docs/mixed-docs/new-doc-slug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
category:
uri: some-category-uri
title: This is the document title
slug: some-slug
---

Body
Empty file.
5 changes: 5 additions & 0 deletions __tests__/__fixtures__/docs/mixed-docs/simple-doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: This is the document title
---

Body
5 changes: 3 additions & 2 deletions __tests__/__fixtures__/docs/multiple-docs/child.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Child
parentDocSlug: parent
parent:
uri: parent
---

# Child Body
Body
2 changes: 1 addition & 1 deletion __tests__/__fixtures__/docs/multiple-docs/friend.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Friend
---

# Friend Body
Body
2 changes: 1 addition & 1 deletion __tests__/__fixtures__/docs/multiple-docs/grandparent.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
title: Grandparent
---

# Grandparent Body
Body
5 changes: 3 additions & 2 deletions __tests__/__fixtures__/docs/multiple-docs/parent.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Parent
parentDocSlug: grandparent
parent:
uri: grandparent
---

# Parent Body
Body
3 changes: 2 additions & 1 deletion __tests__/__fixtures__/docs/new-docs/new-doc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
category: 5ae122e10fdf4e39bb34db6f
category:
uri: category-slug
title: This is the document title
---

Expand Down
5 changes: 3 additions & 2 deletions __tests__/__fixtures__/docs/slug-docs/new-doc-slug.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
category: CATEGORY_ID
category:
uri: some-category-uri
title: This is the document title
slug: marc-actually-wrote-a-test
slug: some-slug
---

Body
Loading
Loading