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

OZ-468: Add docs to create own distribution. #4

Merged
merged 7 commits into from
Mar 6, 2024
Merged

Conversation

rbuisson
Copy link
Contributor

@rbuisson rbuisson commented Mar 5, 2024

Mostly documents how to use the Ozone Maven Archetype.
Also start/stop/destroy instructions.

480p.Screen.Recording.2024-03-05.at.17.42.05.mov

Mostly reuses @ibacher 's PR, but with some adjustments: #1

ibacher and others added 6 commits February 15, 2024 13:26
)

* OZ-450: Clean up and fix of the Quick Start instructions

* OZ-450: Some more adjustments

* OZ-450: Reworked Quick Start. (#3)

* Reworked Quick Start.

@rbuisson my take on it, I haven't yet figured out/decided how to bring the Pro online public demo. But in any case we need to ask folks to browse to the website and click on the Try Demo button (we shouldn't repeat those instructions).

* Referring to 'browser window' instead of 'tab'.

* Update index.md

---------

Co-authored-by: Dimitri R <[email protected]>
Copy link

@ibacher ibacher left a comment

Choose a reason for hiding this comment

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

LGTM

@mks-d mks-d changed the title OZ-468: Add docs to create own Ozone distribution OZ-468: Add docs to create own distribution. Mar 6, 2024
Comment on lines 72 to 75
|--.gitignore
|--.gitpod.yml
|--pom.xml
|--README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the archectype actually generating not only a Maven project but also a local Git repository?

Copy link

Choose a reason for hiding this comment

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

I don't think we're creating a local Git repository. I didn't want to make assumptions about having anything other than Maven installed.

Comment on lines +85 to +90
|Action|Command|
|:----|:----|
|Build the distribution|<pre>./scripts/mvnw clean package</pre>|
|Run the distribution|<pre>source target/go-to-scripts-dir.sh<br/><br/>./start-demo.sh</pre>|
|Stop the distribution|<pre>./stop-demo.sh</pre>|
|Destroy the distribution|<pre>./destroy-demo.sh</pre>|
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll be merging this for now, but I would like to hear from you (@ibacher, @rbuisson) about this table presentation here.

Copy link

Choose a reason for hiding this comment

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

Seems right. The last two commands do assume you're in the directory the ./start-demo.sh script is launched from, but I don't know how to make that clear.

@mks-d mks-d merged commit 4669cb8 into main Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants