Skip to content

Commit e3ab9cb

Browse files
committed
Some minor updates to dev docs
1 parent 2f6242f commit e3ab9cb

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

IntelliJNotes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ The following are some notes taken by a user who set up the plugin for developme
44

55
* Import pom.xml using IntelliJ
66

7-
* Point IntelliJ to the Maven version installed to the Atlassian plugin SDK: File -> Settings -> Build, Execution, Deployment -> Build Tools -> Maven -> Maven home directory. Default installation of the plugin SDK is in C:\Applications\Atlassian
7+
* Point IntelliJ to the Maven version installed to the Atlassian plugin SDK: `File -> Settings -> Build, Execution, Deployment -> Build Tools -> Maven -> Maven home directory`. Default installation of the plugin SDK on Windows is in `C:\Applications\Atlassian`. Set this field to the `apache-maven-...` folder in the SDK folder. (If you run `atlas-build` or `atlas-run`, some of the logs will typically reference the install path.)
88

9-
* To run the built plugin in an instance of bamboo, run the bamboo:run maven task.
9+
* To run the built plugin in an instance of bamboo, run the `bamboo:run` maven task.
1010

11-
* The plugin can be configured with QuickReload in the codedx-bamboo-plugin POM file. If this is set to true, a developer only needs to run bamboo:run, and then run atlas-mvn package in a seperate console session to build an updated version of the plugin, and have the Bamboo instance automatically reload the plugin.
11+
* The plugin can be configured with QuickReload in the codedx-bamboo-plugin POM file. If this is set to true, a developer only needs to run `bamboo:run`, and then run atlas-mvn package in a separate console session to build an updated version of the plugin, and have the Bamboo instance automatically reload the plugin.
1212

1313
* When setting up bamboo, don't forget to configure your git install directory via the Server capabilities administration menu.
1414

15-
* To debug in Intellij: run bamboo:debug, then go to Run->Attach to local process... and select the Catalina process.
15+
* To debug in Intellij: run `bamboo:debug`, then go to `Run->Attach to local process...` and select the Catalina process.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ codedx-bamboo-plugin
88
1. Install Atlassian Plugin SDK: (Windows url) - https://developer.atlassian.com/server/framework/atlassian-sdk/install-the-atlassian-sdk-on-a-windows-system/
99
Additional information about the SDK can be found here - https://developer.atlassian.com/display/DOCS/Introduction+to+the+Atlassian+Plugin+SDK
1010

11-
2. For development, IntelliJ is recommended. If stuck setting up IntelliJ, [some notes are included here](IntelliJNotes.md) from a user who set up the plugin for development in IntelliJ on Windows.
11+
2. For development, IntelliJ is recommended. See [the notes included here](IntelliJNotes.md) for detailed instructions on how to configure IntelliJ to load the project and resolve dependencies.
1212

1313
3. If needed, update the Swagger client [following the instructions here](SwaggerSetup.md). This shouldn't be needed but may be necessary if there is a version mismatch with the Code Dx server.
1414

@@ -30,7 +30,7 @@ codedx-bamboo-plugin
3030

3131
### Running and Debugging from Command Line
3232

33-
* The following commands can be used to run and debug the plugin from the root of this repository. Only the run command was tested (briefly), and it didn't work consistently.
33+
* The following commands can be used to run and debug the plugin from the root of this repository. Only the run command was tested (briefly), and it didn't work consistently. (Normal `mvn` commands won't work, must use the `atlas-*` commands.)
3434

3535
`atlas-run`
3636
`atlas-debug`

0 commit comments

Comments
 (0)