Reorg of docs - prepare to merge by LoisRP · Pull Request #115 · PayString/paystring-documentation

LoisRP · 2020-09-10T18:29:49Z

High Level Overview of Change

Rethink the organization of the docs. Make certain aspects clearer.

Context of Change

The IA should be better.

Type of Change

[x ] Documentation Updates

Before / After

Test Plan

Build and run locally.

Future Tasks

Continue to iterate.

mDuo13

Makes sense all-around to me

mDuo13 · 2020-09-11T06:50:01Z

+
+**NOTES**
+Skeleton doc.
+Actual doc is in review.


This is fine for now, but I don't recommend merging placeholders like this to the main branch. In practice, I think most placeholders or "coming soon" messages end up sitting around indefinitely until they're removed without actually being implemented.

I will get all the content in before merging, and I won't leave any placeholders. I prefer to omit the topic entirely if I had to (and this doc does exist now).

mDuo13 · 2020-09-11T06:53:34Z

 sidebar_label: PayID CLI
 ---

+**NOTES** - This doc will be cut up into tutorial and concepts.


I suggest concept and reference. Usually a CLI is a (particularly boring) means to an end, so it may come up in the context of other tutorials but anything beyond the most basic of examples probably needs more of a task-oriented context. (e.g. "Here's how to delete old PayIDs using the CLI")

I agree, as the Verifiable PayID tutorial actually covers PayID CLI tutorial content anyway.

mDuo13 · 2020-09-11T06:54:21Z

 - You can use [AWS and nginx](remote-deployment) to set up your PayID server, or adapt those instructions to other cloud providers. See the [PayID server requirements](payid-server-requirements) to learn about what types of resources you should deploy.

-To experiment with PayID, you can quickly spin up a local server. First, clone the [PayID reference implementation](https://github.com/payid-org/payid). Then once you are inside the repository you can run `npm run devEnvUp`, which uses the local `docker-compose.yml` file to set up docker containers running a Postgres database and PayID server.
+To experiment with PayID, you can quickly set up a local server. First, clone the [PayID reference implementation](https://github.com/payid-org/payid). From inside the repository, run `npm run devEnvUp`, which uses the local `docker-compose.yml` file to set up Docker containers running a Postgres database and PayID server.


ryangyoung

Once things are a little more baked we could start quibbling over details but this looks like a solid start and definitely the right direction. Excited to see it evolve!

LoisRP · 2020-09-18T08:58:27Z

Will add Xpring SDK tutorial. Have resolved conflicts with master. Have added back some Getting Started content intentionally.

Stormtv · 2020-09-28T18:43:23Z

 Error: Broken links found!
 - Page path = /:
    -> link to xpring-sdk-payid-tutorial (resolved as: /xpring-sdk-payid-tutorial)

ryangyoung

This is looking great. Just a couple of small things that we should change before merging (like removing an internal note) but otherwise, this is a great baseline for the next iterations of the PayID docs!

ryangyoung · 2020-09-28T20:02:48Z


 ## Create a PayID

+Now that you have a PayID server running, you can create a PayID. If your server was publicly accessible, other people could query your account information from your PayID server.


Does this duplicate the following paragraph? The tenses are different in both versions. I'd vote for present tense or whatever's most easily consistent.

ryangyoung · 2020-09-28T20:04:20Z

+sidebar_label: Set Up NGINX Reverse Proxy and SSL
+---
+
+After you set up a PayID server using your preferred [deployment option](intro-deploy.md), you can set up NGINX Reverse Proxy + SSL for load balancing and security.


ryangyoung · 2020-09-28T20:09:06Z

-sidebar_label: Overview
+id: welcome-to-payid
+title: Welcome to PayID
+sidebar_label: Welcome to PayID


Food for thought: will this page need any revision for the new docs landing page?

ryangyoung · 2020-09-30T00:01:40Z

+
 ## PayID standards

 PayID is an open standard. Commentary is welcome. You can open a Github issue to provide feedback.


Suggested change

PayID is an open standard. Commentary is welcome. You can open a Github issue to provide feedback.

PayID is an open standard. Commentary is welcome. You can open a [Github issue](https://github.com/payid-org/payid) to provide feedback.

ryangyoung

Looks good! Made one tiny suggestion that doesn't preclude the merge!

LoisRP added 3 commits September 10, 2020 11:23

reorganized docs for 1st iteration

d53ee60

ran lint

5576072

added notes

bc54992

LoisRP requested a review from ryangyoung September 10, 2020 18:29

mDuo13 approved these changes Sep 11, 2020

View reviewed changes

ryangyoung reviewed Sep 11, 2020

View reviewed changes

LoisRP added 2 commits September 16, 2020 09:56

updated reorg

f7fae78

run lint

2755460

ryangyoung reviewed Sep 16, 2020

View reviewed changes

Comment thread sidebars.js Outdated

LoisRP added 13 commits September 17, 2020 15:48

modified sidebar

20baabf

docs reorg in progress

cd4a471

re-add images as part of reorg

e6949b1

ran lint

862f53b

add link

c10d6b8

more edits to synchronize

06454a6

more edits

3b9f7fa

split up PayID CLI doc

a69a30d

removed PayID CLI tutorial because covered by Verifiable PayID tutorial

2dbf0d1

minor edits

e06b75b

merge conflicts fixed

31bebcb

ran lint

9c71928

setup tutorials removed for now, as deployment pages explain well

f8ba7ff

LoisRP added 2 commits September 25, 2020 00:43

added tutorial for Xpring and PayID based on demo

7749ef2

Merge branch 'master' into loisrp-reorg

9ed9256

LoisRP marked this pull request as ready for review September 25, 2020 07:53

LoisRP requested a review from Stormtv as a code owner September 25, 2020 07:53

LoisRP changed the title ~~WIP: Reorg of docs, iterating on options - DO NOT MERGE~~ Reorg of docs - prepare to merge Sep 28, 2020

ryangyoung suggested changes Sep 28, 2020

View reviewed changes

LoisRP added 3 commits September 28, 2020 13:22

link fix

aae46c9

change link text

dccc897

another edit to link text

aaaac9b

ryangyoung reviewed Sep 28, 2020

View reviewed changes

Comment thread docs/welcome-to-payid.md

Stormtv approved these changes Sep 28, 2020

View reviewed changes

LoisRP added 2 commits September 29, 2020 03:15

updates as suggested by reviewers

23cf8ea

added github link

42d91bb

LoisRP requested a review from ryangyoung September 29, 2020 10:48

ryangyoung reviewed Sep 30, 2020

View reviewed changes

ryangyoung approved these changes Sep 30, 2020

View reviewed changes

LoisRP merged commit 08a6fd6 into master Sep 30, 2020

LoisRP deleted the loisrp-reorg branch September 30, 2020 00:19


		## Create a PayID

		Now that you have a PayID server running, you can create a PayID. If your server was publicly accessible, other people could query your account information from your PayID server.


		## PayID standards

		PayID is an open standard. Commentary is welcome. You can open a Github issue to provide feedback.

Conversation

LoisRP commented Sep 10, 2020

High Level Overview of Change

Context of Change

Type of Change

Before / After

Test Plan

Future Tasks

Uh oh!

mDuo13 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ryangyoung left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

LoisRP commented Sep 18, 2020

Uh oh!

Stormtv commented Sep 28, 2020

Uh oh!

ryangyoung left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ryangyoung left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants