PR: Rewrote configuration to emphasis singular App class usage
#288
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
bbrennanbasis
changed the title
App class usageApp class usage
|
@bbrennanbasis It looks good. Please review all the Vale issues on this page and ensure they are fixed. Thank you! |
- Removed the step-by-step parts of routing. - Mentioned the other way to run specific programs (inside the class extending `App`).
bbrennanbasis
force-pushed
the
231-default-class
branch
from
b7c636f to
0f07b98
Compare
|
@hyyan I removed the specific step-by-step instructions for routing and mentioned the other way of running a specific app (using the class that extends |
|
@MatthewHawkins, please review this and check if it aligns with the plans for documenting the new configuration approach. It might be best to hold off until you've completed that. |
|
@hyyan I read over the changes here and it looks better to me. I'm not opposed to merging before the new WAR configuration is documented, as I believe enforcing this behavior with the routing changes implemented is sufficient, but if you'd prefer to wait until that's completed, then no problem. |
|
@bbrennanbasis requested minor formatting changes |
- Changed application to app - Removed misleading wording talking about with and without the plugin - Rewrote Default class section and changed the header name
|
| @@ -38,29 +38,43 @@ When using the installation plugin, the tags within the `<configuration>` tag ca | |||
|
|
|||
| - **`<deployurl>`** This tag is the URL where the webforJ endpoint for the project installation can be reached. For users running their application locally, a default port of 8888 is used. For users running Docker, the port should be changed to the port that was entered when [configuring the Docker container](../installation/docker.md#2-configuration). | |||
|
|
|||
| - **`<classname>`** This tag should contain the package and class name of the application you wish to run. This is helpful for projects that contain multiple classes that extend the `App` class, and allows you to choose which program to run from the base URL. | |||
| - **`<classname>`** This tag should contain the package and class name of the application you wish to run. This will be the single class in your project that extends the `App` class and runs from the base URL. | |||
There was a problem hiding this comment.
Let's change to say "app" or "program", and let's not mention the last section about the base URL, as we'll link the routing section later on in the docs, but want to keep that in its own section otherwise.
|
|
||
| - **`<publishname>`** This tag specifies the name of the application in the published URL. Generally, to run your program, you'll navigate to a URL similar to `http://localhost:8888/webapp/<publishname>`, replacing `<publishname>` with the value in the `<publishname>` tag. Then, the program specified by the `<classname>` tag is run. | ||
|
|
||
| - **`<debug>`** The debug tag can be set to true or false, and will determine whether or not the browser's console displays error messages thrown by your program. | ||
|
|
||
| ### Running a specific application | ||
| ### Running a specific program | ||
|
|
There was a problem hiding this comment.
In this section, let's avoid going into any detail about routing. Instead, an admonition (tip, maybe) somewhere in this section linking to the routing docs should be perfect to get people started.
This PR closes #231.