Skip to content
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

Docs: Getting Started content for Documentation #96

Merged
merged 29 commits into from
Jul 5, 2018
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
99dabfe
Getting started topics and links in readmes
bernars-usa Jun 20, 2018
7e1d785
Remove old Getting Started topic
bernars-usa Jun 20, 2018
a6b6162
Getting Started short descriptions
bernars-usa Jun 20, 2018
7083cc5
Map shortdescs
bernars-usa Jun 20, 2018
a5f1e12
Main content for starter app topic
bernars-usa Jun 20, 2018
d6ebe8d
Structure for existing app topic
bernars-usa Jun 20, 2018
38c32c9
Installation instructions
bernars-usa Jun 20, 2018
e328112
Instructions for required files
bernars-usa Jun 20, 2018
dd2b2e6
Missing topic
bernars-usa Jun 20, 2018
f1d0385
A little more about the routes file
bernars-usa Jun 20, 2018
f48aae1
Spacing, does it matter?
bernars-usa Jun 20, 2018
2bc4870
Apparently it's bash
bernars-usa Jun 20, 2018
7272c08
Standardize on 'US Forms System'
bernars-usa Jun 21, 2018
64444c1
Merge forms-docs into getting-started
bernars-usa Jun 22, 2018
d92a508
Add a link to React tutorial, weird tweak to app.js description?
bernars-usa Jun 22, 2018
301761f
Merge forms docs into getting-started
bernars-usa Jun 28, 2018
3315bf8
Add prereqs
bernars-usa Jun 29, 2018
21cf015
Move this list into a separate file so it can be referenced in both o…
bernars-usa Jun 29, 2018
f8d03cc
Link to the new file at the top of the other two
bernars-usa Jun 29, 2018
306c08c
Revised 'Creating a new app' with a lot more instructions, including …
bernars-usa Jul 2, 2018
ce5cac4
Add links to Getting Started articles
bernars-usa Jul 2, 2018
260b607
React link is elsewhere now
bernars-usa Jul 2, 2018
7ec572f
Someday I'll learn Markdown
bernars-usa Jul 2, 2018
d4d7361
Merge forms-docs into getting-started
bernars-usa Jul 5, 2018
c52261a
Merge forms-docs into getting-started
bernars-usa Jul 5, 2018
b39fd15
Talk about how to view output
bernars-usa Jul 5, 2018
5467b2c
Formation not required
bernars-usa Jul 5, 2018
aa68e4c
Minimum node.js 8.0.0
bernars-usa Jul 5, 2018
a56de80
Link to USWDS for funsies
bernars-usa Jul 5, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# US Forms System Documentation

- [Getting started with the Forms System Library](getting-started/README.md)
- Creating a new application with the US Forms System Starter App
- Installing the library in an existing application
- [Getting started with the US Forms System](getting-started/README.md)
- [Creating a new application with the US Forms System Starter App](getting-started/creating-a-new-application-with-the-us-forms-system-starter-app.md)
- [Installing the US Forms System in an existing application](getting-started/installing-the-us-forms-system-in-an-existing-application.md)
- [Building a form](building-a-form/README.md)
- About the JSON schema standard and react-jsonschema-form
- Creating a form config file
- Adding widgets
- Adding definitions
- Creating custom widgets
Expand Down
31 changes: 0 additions & 31 deletions docs/getting-started.md

This file was deleted.

12 changes: 9 additions & 3 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Getting started with the Forms System Library
# Getting started with the US Forms System

### Creating a new application with the US Forms System Starter App
Depending on your needs, you can either create a brand new application from scratch or install the US Forms System in an existing application. For more information about React apps, see the [React project's Hello World tutorial](https://reactjs.org/docs/hello-world.html).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added a link to a React tutorial here. Let me know if that feels like overkill.


### Installing the library in an existing application
### [Creating a new application with the US Forms System Starter App](getting-started/creating-a-new-application-with-the-us-forms-system-starter-app.md)

The US Forms System Starter App creates the initial files, configuration, build process, and web server you need to start building your form immediately.

### [Installing the US Forms System in an existing application](getting-started/installing-the-library-in-an-existing-application.md)

If you're using an existing React application, you can install the US Forms System in that app.

[Back to *US Forms System Documentation*](/docs/README.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Creating a new application with the US Forms System Starter App

The US Forms System Starter App creates the initial files, configuration, build process, and web server you need to start building your form immediately.

For more information, including app installation instructions, see the [US Forms System Starter App README](https://github.com/usds/us-forms-system-starter-app#us-forms-system-starter-app).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was talking to @fatimanoorva this afternoon about where to put the instructions for setting up the starter app. I'm leaning toward wanting to keep the instructions in this repo alongside the other docs, rather than keeping two sets of docs in separate repos. Thoughts/feelings?

There's also an issue open about needing to enhance those instructions (#79). I'm working on getting the starter app running on my machine, too, and taking notes.


[Back to *Getting Started with the US Forms System*](README.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Installing the US Forms System in an existing application

If you're using an existing React application, you can install the US Forms System in that app.

### In this guide

- [Install the library and dependencies](#install-the-library-and-dependencies)
- [Create required files](#create-required-files)

### Install the library and dependencies

1. Install the library:
```bash
npm install --save https://github.com/usds/us-forms-system.git
```

2. Install peer dependencies:
```bash
npm install --save-dev @department-of-veterans-affairs/formation
Copy link
Contributor

Choose a reason for hiding this comment

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

We no longer need formation, so you can remove this line!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was wondering about that one!

npm install --save-dev uswds@^1.6.3
npm install --save-dev react@^15.5.4
npm install --save-dev react-dom@^15.6.2
```

### Create required files

To enable your form, create the following files. For an example of these files, see the [us-forms-system-starter-app repository](https://github.com/usds/us-forms-system-starter-app).

- A [form config file](https://github.com/usds/us-forms-system-starter-app/blob/master/js/config/form.js). For more information, see "Creating a form config file."
- An entry [app.js](https://github.com/usds/us-forms-system-starter-app/blob/master/app.js) file.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@annekainicUSDS - Is this an acceptable description?

Copy link
Contributor

Choose a reason for hiding this comment

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

yes I think so

- A [React component](https://github.com/usds/us-forms-system-starter-app/blob/master/js/components/Form.jsx) to render the top-level us-forms-system component.
- A [routes file](https://github.com/usds/us-forms-system-starter-app/blob/master/js/routes.jsx) that loads `createRoutes` from us-forms-system. This automatically creates the routes from the form config file.
- A [reducers file](https://github.com/usds/us-forms-system-starter-app/blob/master/js/reducers.js) that loads `createSchemaFormReducer` from us-forms-system. This creates the app's reducer functions.

[Back to *Getting Started with the US Forms System*](README.md)