Add Documentation - How to create an openEQUELLA dev environment in Ubuntu #73
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…Box-Ubuntu-OS.md test image path
…equella.github.io into matjmiles-patch-1
|
Heya @matjmiles Thanks for this. One thing before I review though, developer documentation currently sits over in the core repository. Specifically for this kind of guide, it would sit in https://github.com/openequella/openEQUELLA/tree/develop/Dev/docs Once there, it'd then be worth linking to from either the root README.md or CONTRIBUTING.md. Or then again, the Dev/README.md. Would it be possible for you to do a PR along those lines? |
|
Yes
…Sent from my iPhone
On Sep 15, 2020, at 8:49 PM, edalex-ian <[email protected]<mailto:[email protected]>> wrote:
Heya @matjmiles<https://github.com/matjmiles>
Thanks for this.
One thing before I review though, developer documentation currently sits over in the core repository. Specifically for this kind of guide, it would sit in https://github.com/openequella/openEQUELLA/tree/develop/Dev/docs
Once there, it'd then be worth linking to from either the root README.md or CONTRIBUTING.md. Or then again, the Dev/README.md.
Would it be possible for you to do a PR along those lines?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#73 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACG3ZA64DKCW5P7NCWUL5NDSGARU3ANCNFSM4RN37F6Q>.
|
|
Ok, I created the pull request in the manner you requested. Hopefully I did it correctly.
From: edalex-ian <[email protected]>
Sent: Tuesday, September 15, 2020 8:50 PM
To: openequella/openequella.github.io <[email protected]>
Cc: Miles, Mathew <[email protected]>; Mention <[email protected]>
Subject: Re: [openequella/openequella.github.io] Add Documentation - How to create an openEQUELLA dev environment in Ubuntu (#73)
Heya @matjmiles<https://github.com/matjmiles>
Thanks for this.
One thing before I review though, developer documentation currently sits over in the core repository. Specifically for this kind of guide, it would sit in https://github.com/openequella/openEQUELLA/tree/develop/Dev/docs
Once there, it'd then be worth linking to from either the root README.md or CONTRIBUTING.md. Or then again, the Dev/README.md.
Would it be possible for you to do a PR along those lines?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub<#73 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ACG3ZA64DKCW5P7NCWUL5NDSGARU3ANCNFSM4RN37F6Q>.
|
| @@ -0,0 +1 @@ | |||
| Welcome to the openEQUELLA wiki! | |||
There was a problem hiding this comment.
It this page a placeholder?
Is there more content planned for it, or will it be a table of contents?
Comment on lines
+3
to
+20
| * <a href="#download-ubuntu">Download Ubuntu Desktop Software</a> | ||
| * <a href="#install-oracle">Install Oracle Virtual Box VM Software</a> | ||
| * <a href="#install-sdkman">Install sdkman to Run and Manage Java 8</a> | ||
| * <a href="#install-postgres">Install Postgresql</a> | ||
| * <a href="#install-pgadmin">Install Pgadmin4</a> | ||
| * <a href="#install-libinfo5">Install libtinfo5</a> | ||
| * <a href="#install-npm">Install npm</a> | ||
| * <a href="#install-node">Install Nodejs</a> | ||
| * <a href="#install-imagemagick">Install ImageMagick</a> | ||
| * <a href="#install-git">Install Git</a> | ||
| * <a href="#install-intellij">Install Intellij</a> | ||
| * <a href="#install-ssh">Generate an SSH key and Add it to the ssh-agent</a> | ||
| * <a href="#add-key">Add the ssh key to your openEQUELLA GitHub Repository</a> | ||
| * <a href="#clone-repo">Clone the openEQUELLA Repository</a> | ||
| * <a href="#install-sbt">Install SBT</a> | ||
| * <a href="#create-branch">Create a New Branch of openEQUELLA in Git</a> | ||
| * <a href="#import-sbt">Import sbt project into Intellij</a> | ||
| * <a href="#compile-run">Compile and Run openEQUELLA Server</a> |
There was a problem hiding this comment.
Could we make these markdown links?
https://www.markdownguide.org/basic-syntax#links
Comment on lines
+302
to
+321
| `$ sudo /usr/pgadmin4/bin/setup-web.sh` | ||
|
|
||
| `The output should look like what you see below. You will be prompted for an email address and password. You will also be prompted to restart the apache server. ` | ||
|
|
||
| `Setting up pgAdmin 4 in web mode on a Debian platform...` | ||
| `Creating configuration database...` | ||
| `NOTE: Configuring authentication for SERVER mode.` | ||
|
|
||
| `Enter the email address and password to use for the initial pgAdmin user account:` | ||
|
|
||
| `Email address: [email protected]` | ||
| `Password:` | ||
| `Retype password:` | ||
| `pgAdmin 4 - Application Initialisation` | ||
| `======================================` | ||
|
|
||
| `Creating storage and log directories...` | ||
| `We can now configure the Apache Web server for you. This involves enabling the wsgi module and configuring the pgAdmin 4 application to mount at /pgadmin4. Do you wish to continue (y/n)? y` | ||
| `The Apache web server is running. A restart is required for the pgAdmin 4 installation to complete. Would you like to continue (y/n)? y` | ||
| `Apache successfully restarted. You can now start using pgAdmin 4 in web mode` |
There was a problem hiding this comment.
Could this be made a single, multi-line code block?
https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/creating-and-highlighting-code-blocks
Comment on lines
+475
to
+479
| `$ cd /home/developer`</br> | ||
| `$ mkdir git_proj`</br> | ||
| `$ git config --global user.name “mjm”`</br> | ||
| `$ git config --global user.email [email protected]`</br> | ||
| `$ git clone [email protected]:someone/openEQUELLA.git ` |
There was a problem hiding this comment.
Comment on lines
+558
to
+559
| `Sbt:Equella> compile`</br> | ||
| `Sbt:Equella> prepareDevConfig` |
There was a problem hiding this comment.
…Box-Ubuntu-OS.md Fixed one and two. Working on the image problem.
Update How-to-install-openEQUELLA-Development-Environment-in-Virtual-…
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a detailed step by step instructional document that walks the user through setting up the Ubuntu vm, openEquella and all of it's dependencies.