Skip to content

Initial Porter Documentation#2721

Merged
KPrasch merged 9 commits intonucypher:porterfrom
derekpierre:hey-whats-up-doc
Jul 3, 2021
Merged

Initial Porter Documentation#2721
KPrasch merged 9 commits intonucypher:porterfrom
derekpierre:hey-whats-up-doc

Conversation

@derekpierre
Copy link
Copy Markdown
Member

@derekpierre derekpierre commented Jun 10, 2021

Type of PR:

  • Bugfix
  • Feature
  • Documentation
  • Other

Required reviews:

  • 1
  • 2
  • 3

What this does:
Initial documentation of Porter. Based over #2726 .

Issues fixed/closed:
Related to #2670 .

Notes for reviewers:
Build artifact available here - https://136953-100446516-gh.circle-artifacts.com/0/docs/build/html/application_development/porter.html.

This is an initial writeup of already implemented functionality up to "basic authentication" (#2726 ). /revoke and /exec_work_order APIs haven't been implemented as yet.

I would like to also add some application-specific documentation about specifics of using Porter aside from just stating the API. I intend to add this in separate PRs.

One mistake I made is doing documentation as a separate task, instead of providing a simple base document and then adding to the document as part of implementation PRs so that it builds up over time. To rectify that I'll merge this PR now as an initial base, and then add to it over time in subsequent PRs moving forward.

@derekpierre derekpierre added the documentation Effects the official documentation label Jun 10, 2021
@derekpierre derekpierre added this to the Porter v1 (MVP) milestone Jun 10, 2021
@derekpierre derekpierre self-assigned this Jun 10, 2021
@derekpierre derekpierre marked this pull request as draft June 10, 2021 19:56
@derekpierre derekpierre force-pushed the hey-whats-up-doc branch 5 times, most recently from c22d449 to 97fbcea Compare June 23, 2021 14:31
@derekpierre derekpierre changed the title [WIP] Porter Documentation [WIP] Initial Porter Documentation Jun 23, 2021
@derekpierre derekpierre linked an issue Jun 23, 2021 that may be closed by this pull request
@derekpierre derekpierre marked this pull request as ready for review June 24, 2021 15:15
@derekpierre derekpierre changed the title [WIP] Initial Porter Documentation Initial Porter Documentation Jun 24, 2021
Copy link
Copy Markdown
Member

@KPrasch KPrasch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤠

@KPrasch KPrasch merged commit b922e61 into nucypher:porter Jul 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Effects the official documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation of Porter

3 participants