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

Add more details about starting up an islandora. #1597

Merged
merged 6 commits into from
Aug 31, 2020

Conversation

rosiel
Copy link
Member

@rosiel rosiel commented Aug 28, 2020

Purpose / why

The "demo" section was really sparse, and there are several ways to quickly try out an islandora. i know this'll be updated again come ISLE, but I think it's useful to have documented! (todo also: improve the installation section to match/be updated).

What changes were made?

Replaced a lonely link to the future.islandora.ca sandbox, and a complex way of installing with vagrant (which didn't do what we thought it did, since the islandora base box!) with a more fulsome and up-to-date version, also mention the VMs!

Verification

Uh, links work? Instructions work? Statements accurate? Etc?

Interested Parties

@manez @DonRichards (pinging for interest in documentation! :) ) @dannylamb

Related issue:


Checklist

Pull-request reviewer should ensure the following

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

docs/index.md Outdated
$ ISLANDORA_DISTRO="centos/7" vagrant up
### Islandora Base Box via Vagrant

If you have Vagrant and Git installed as well as VirtualBox, you can spin up the latest release of Islandora Defaults using the [Islandora Playbook](https://github.com/Islandora-Devops/islandora-playbook)'s Vagrantfile. Out of the box, `vagrant up` will download the latest release of Islandora as the [Islandora 8 Base Box](https://app.vagrantup.com/islandora/boxes/8). It will also set up shared folders and port forwarding, but (as of June 2020) will not do any Ansible Provisioning, because the Islandora 8 Base Box has been already provisioned. Same credentials as above, with further documented in its README file.
Copy link
Member Author

Choose a reason for hiding this comment

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

I just learned, in making #1598 , that you also have to change to the dev branch!

Copy link
Member

@manez manez left a comment

Choose a reason for hiding this comment

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

The sandbox and the VM both have some extra bells and whistles beyond Defaults, which we should probably mention so folks don't expect them in the ISLE or Ansible builds where they don't show up.

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
@manez
Copy link
Member

manez commented Aug 31, 2020

Tested the instructions and reviewed the wording. All good!

@manez manez merged commit 50b70a3 into Islandora:main Aug 31, 2020
@rosiel rosiel deleted the improve-the-try-islandora-section branch September 1, 2020 14:26
dannylamb pushed a commit that referenced this pull request Sep 11, 2020
* Add more details about starting up an islandora.

* Update index.md

* Mention use of dev branch for prebuilt base box

* Update index.md

* Fix typo in VBE

* Make clearer the different levels of sandbox reqs.
whikloj pushed a commit that referenced this pull request Sep 30, 2020
* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Mention the User Call (#1587)

* Update rdf-mapping.md doc (#1585)

* Update committers.md (#1592)

* Fix committer nomination email address (#1593)

* Fix old email address.

* Update closeCommitterVote.txt

* De-CLAW

* De-CLAW

* DeCLAW

* Change email

* De-CLAW

* Update travis for the main branch switch (#1594)

* Master -> Main Rename

* Remove comments about WebAC (#1555)

* Remove comments about WebAC

WebAC is not used but is listed as a feature added when using Fedora. Although it is there, I'd suggest leaving off of this documentation.

* Update user-intro.md

* Add more details about starting up an islandora. (#1597)

* Add more details about starting up an islandora.

* Update index.md

* Mention use of dev branch for prebuilt base box

* Update index.md

* Fix typo in VBE

* Make clearer the different levels of sandbox reqs.

* Update CONTRIBUTING.md (#1601)

* Add Jordan to committers list (#1602)

* Migration docs updates (#1603)

* Added link to newer migration Youtube vid, added migration-overview.md

* Replaced used of "*" with "-" for bulleted lists

* Updated headings in docs and spelling changes

* Main update (#1612)

* Render the example helpful tip properly. (#1586)

* Render the example helpful tip properly.

* Fix note syntax, again.

* Update rdf-mapping.md doc (#1585)

Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>

* Merge changes to add @manez to committers. (#1613)

* Merge changes to add @manez to committers.

* Alphabeticalize committer names.

Co-authored-by: dannylamb <dlamb@islandora.ca>

* De-CLAWing

* Derp

* Missing parenthesis

Co-authored-by: Rosie Le Faive <lefaive@gmail.com>
Co-authored-by: Eli Zoller <5439169+elizoller@users.noreply.github.com>
Co-authored-by: Jonathan Green <jonathan.green@lyrasis.org>
Co-authored-by: Don Richards <DonRichards@utk.edu>
Co-authored-by: Melissa Anez <manez@islandora.ca>
Co-authored-by: Yamil <ysuarez@users.noreply.github.com>
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.

2 participants