posit-dev / posit-dev/connect-extensions

Convert quarto-website into an extension, fold connectwidgets-example into it

Open
#385 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
10
Forks
8
Avg merge
5d 18h
Merged PRs (30d)
1

Description

Convert quarto-website into an extension that serves as a viewer-OAuth Content Hub. Fold in relevant pants of connectwidgets-example: the "list my content" role via client-side OJS/JS hitting the public GET /v1/content (per-viewer via the browser session), before deleting standalone connectwidgets-example.

Note: Do not import connectwidgets because it uses non-public APIs that we don’t want to continue exposing/supporting.

Here is a non-exhaustive list of things we'll want to make sure are completed:

  • README: rewrite into a genuinely useful doc: what the tool does, who it's for, setup/configuration, and how to use it.
  • Well-commented source: comments should explain the why, not just the what.
  • Title: in Framework: Functionality form.
  • Description: concise; states the functionality and value. Where relevant, names a themed industry with an "applies to any …" cue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing quarto-website and connectwidgets-example implementations, focusing on the client-side OJS/JS flow and the public GET /v1/content endpoint used with the browser session. Done means the functionality is folded into the extension, standalone connectwidgets-example is removed, and the README, source comments, title, and description meet the stated requirements without importing connectwidgets.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, authentication, documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.