-
Notifications
You must be signed in to change notification settings - Fork 62
docs: add feedback widget for docs pages (fixes DOCSDEV-4) #779
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
953b9cc
feat(docs): add feedback widget
JonathanMatthey 5e67fac
pnpm format
JonathanMatthey 5e7bd61
update emojis
JonathanMatthey c3445a4
feat(docs): use GitHub App auth for feedback and Netlify dev
JonathanMatthey d0c16ce
refactor(docs): simplify feedback Netlify function
JonathanMatthey c0048a9
pnpm lock
JonathanMatthey acb4031
chore(docs): fix prettier and eslint ignore for .netlify
JonathanMatthey File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -124,3 +124,6 @@ styles/write-good/TooWordy.yml | |
| styles/write-good/Weasel.yml | ||
| .vale.ini | ||
| vale | ||
|
|
||
| # Local Netlify folder | ||
| .netlify | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Local direct-submit config for Netlify dev. | ||
| # GitHub App (installation must have "Issues: write" on interledger/open-payments-docs-feedback) | ||
| GITHUB_APP_ID= | ||
| GITHUB_APP_INSTALLATION_ID= | ||
| # Either set PEM inline (Netlify: use literal \n for newlines) or point to a local file | ||
| GITHUB_APP_PRIVATE_KEY= | ||
| GITHUB_APP_PRIVATE_KEY_PATH= | ||
| PUBLIC_FEEDBACK_FUNCTION_URL=/.netlify/functions/feedback |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # Feedback Widget | ||
|
|
||
| The docs footer can either: | ||
|
|
||
| - open a prefilled issue in `interledger/open-payments-docs-feedback` | ||
| - post directly to GitHub through `docs/netlify/functions/feedback.ts` | ||
|
|
||
| `openpayments.dev` is a GitHub Pages deploy, so production uses the issue-form fallback | ||
| unless you point `PUBLIC_FEEDBACK_FUNCTION_URL` at another hosted endpoint. | ||
|
|
||
| ## Local dev | ||
|
|
||
| 1. Copy `docs/.env.example` to `docs/.env`. | ||
| 2. Run `pnpm dev:netlify` from `docs/`, or `pnpm --filter docs dev:netlify` from the repo root. | ||
| 3. Open the Netlify URL shown as `Local dev server ready`. | ||
|
|
||
| Plain `pnpm start` only exercises the fallback path. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| [build] | ||
| command = "pnpm --dir docs build" | ||
| publish = "docs/dist" | ||
|
|
||
| [functions] | ||
| directory = "docs/netlify/functions" | ||
|
|
||
| [dev] | ||
| command = "pnpm exec astro dev --host --port 1104 --strictPort" | ||
| targetPort = 1104 |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.