Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Commit

Permalink
Improve quick start, fix code/TypeDoc links
Browse files Browse the repository at this point in the history
Add JDK prerequisite.  Add information about how long things might
take to Developer Quick Start.

Fix code and TypeDoc links after code reorganization.
  • Loading branch information
David Dooling committed Sep 17, 2018
1 parent c332b7e commit 0f90223
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/developer/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ contains the following useful members:
When you need more information, define [parameters](#parameters)
in your command handler.

[handler-context]: https://atomist.github.io/automation-client-ts/interfaces/_handlercontext_.handlercontext.html (Reference Documentation - Handler Context)
[handler-context]: https://atomist.github.io/automation-client-ts/interfaces/_lib_handlercontext_.handlercontext.html (Reference Documentation - Handler Context)

### Handler return

Expand Down
4 changes: 2 additions & 2 deletions docs/developer/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ See the [UpdateCopyright example](https://github.com/atomist/automation-client-s

### Pull requests or commits

The `editMode` passed in the details to `editorHandler` determines how to save the changes. Pass an instance of [PullRequest](https://atomist.github.io/automation-client-ts/classes/_operations_edit_editmodes_.pullrequest.html), or an implementation of [BranchCommit](https://atomist.github.io/automation-client-ts/interfaces/_operations_edit_editmodes_.branchcommit.html). You can also supply a function from parameters to one of these EditModes, in case you want the branch name or commit message to vary by invocation.
The `editMode` passed in the details to `editorHandler` determines how to save the changes. Pass an instance of [PullRequest](https://atomist.github.io/automation-client-ts/classes/_lib_operations_edit_editmodes_.pullrequest.html), or an implementation of [BranchCommit](https://atomist.github.io/automation-client-ts/interfaces/_lib_operations_edit_editmodes_.branchcommit.html). You can also supply a function from parameters to one of these EditModes, in case you want the branch name or commit message to vary by invocation.

## Testing a project editor

Expand Down Expand Up @@ -100,7 +100,7 @@ it("adds the file", (done) => {
## Working with projects
The [Project](https://atomist.github.io/automation-client-ts/interfaces/_project_project_.project.html) abstraction aims to provide both synchronous and asynchronous ways of changing projects. The synchronous methods simplify testing,
The [Project](https://atomist.github.io/automation-client-ts/interfaces/_lib_project_project_.project.html) abstraction aims to provide both synchronous and asynchronous ways of changing projects. The synchronous methods simplify testing,
while the asynchronous ones will give better performance in your automations.
If you want to modify the filesystem directly in your ProjectEditor function, do what you like; find the underlying directory in `project.baseDir`.
Expand Down
8 changes: 4 additions & 4 deletions docs/developer/sdm.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ from the file system, making it easy to unit test with mocked
repository contents, using the `InMemoryProject` and `InMemoryFile`
classes.

[project]: https://atomist.github.io/automation-client-ts/interfaces/_project_project_.project.html (Atomist Automation Client TypeScript - Project)
[project]: https://atomist.github.io/automation-client-ts/interfaces/_lib_project_project_.project.html (Atomist Automation Client TypeScript - Project)
[client]: https://github.com/atomist/automation-client-ts (Atomist Automation Client TypeScript)

!!! Note
Expand Down Expand Up @@ -362,7 +362,7 @@ When a new issue is created, you may want to notify people or perform an action.
#### Listener interfaces
1. `NewIssueListener`: [NewIssueListener](https://github.com/atomist/sdm/blob/master/src/api/listener/NewIssueListener.ts)
1. `NewIssueListener`: [NewIssueListener](https://github.com/atomist/sdm/blob/master/lib/api/listener/NewIssueListener.ts)
#### Examples
Expand Down Expand Up @@ -402,9 +402,9 @@ tag it with GitHub topics based on its contents.
There are two scenarios to consider:
1. The creation of a new repository. `RepoCreationListener`:
[RepoCreationListener](https://github.com/atomist/sdm/blob/master/src/api/listener/RepoCreationListener.ts)
[RepoCreationListener](https://github.com/atomist/sdm/blob/master/lib/api/listener/RepoCreationListener.ts)
2. The first push to a repository, which uses the more generic
[ProjectListener](https://github.com/atomist/sdm/blob/master/src/api/listener/PushListener.ts)
[ProjectListener](https://github.com/atomist/sdm/blob/master/lib/api/listener/PushListener.ts)
The second scenario is usually more important, as it is possible to
create a repository without any source code or a master branch, which
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If you're not familiar with the main concepts of Slack message formatting, you m

## MessageClient interface

Let's take a look at the [`MessageClient`](https://github.com/atomist/automation-client-ts/blob/master/src/spi/message/MessageClient.ts) interface.
Let's take a look at the [`MessageClient`](https://github.com/atomist/automation-client-ts/blob/master/lib/spi/message/MessageClient.ts) interface.

```typescript
export interface MessageClient {
Expand Down
12 changes: 8 additions & 4 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
The easiest way to get started with Atomist is to start on your
laptop, working with local commits. You'll need [Git][git] and
[Node.js][node] installed.
laptop, working with local commits. You'll need [Git][git],
[Node.js][node], and the [Java JDK][jdk] installed.

[git]: https://git-scm.com/downloads (Install Git)
[node]: https://nodejs.org/ (Node.js)
[jdk]: https://www.oracle.com/technetwork/java/javase/downloads/jdk10-downloads-4416644.html (Java JDK Downloads)

## Quick start

Expand All @@ -28,7 +29,8 @@ laptop, working with local commits. You'll need [Git][git] and
atomist start --local

The above command will install the project dependencies using NPM,
compile the TypeScript, and start your SDM.
compile the TypeScript, and start your SDM. Depending on your
network connect, this may take a minute or more.

5. In another terminal, start up the SDM feed so you can see what the
SDM is doing.
Expand All @@ -48,7 +50,9 @@ laptop, working with local commits. You'll need [Git][git] and

If you look in the terminal with the Atomist feed, you will see
the SDM cloning the seed repository, cloning it locally, building
it, and deploying it locally.
it, and deploying it locally. The first time you run this, it may
take a few minutes as it downloads all the Maven and project
dependencies.

![Atomist Feed for Create Spring Project](img/atomist-feed-create-spring.png)

Expand Down

0 comments on commit 0f90223

Please sign in to comment.