PR Page

This page exists for every PR in a repository connected with cdoc.

URL & Params

URL: <cdoc-base-url>/<repo-name>/pulls/<pr-number>/?query=<>

cdoc-base-url

For hosted cdoc this would be gh.fifthtry.com (and gl.fifthtry.com in future when we support Gitlab and so on). For self-hosted cdoc it would be the domain where it is hosted.

repo-name, pr-number

repo-name, eg FifthTry/fpm and pr-number identy the pull request.

query

This optional parameter contains the search term user has entered in the search box.

Design

Not Connected State

In this we show all PRs in the corresponding documentation repository, and next to each show a “connect” button.

Unapproved State

Approved State

TODO

Data

-- record result:
string pr-number:
string pr-title:
string pr-url:

-- record data:
string account-name:
string account-url:
string repo-name:
string repo-url:
string pr-number:
string pr-title:
string pr-body:
string pr-url:
optional string query:
result list result:

-- record result:
string pr-number:
string pr-title:
string pr-url:

-- record data:
string account-name:
string account-url:
string repo-name:
string repo-url:
string pr-number:
string pr-title:
string pr-body:
string pr-url:
optional string query:
result list result: