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

[DOCS] CRAYFISH_DB_xxx in manual installation documentation for Milliner component #2182

Closed
robyj opened this issue Oct 14, 2022 · 5 comments
Labels
Type: documentation provides documentation or asks for documentation.

Comments

@robyj
Copy link

robyj commented Oct 14, 2022

  • If applicable, link to the documentation page relevant to your issue below.
    https://islandora.github.io/documentation/installation/manual/installing_crayfish/

  • If this is a request for new documentation, where in the existing documentation does this documentation belong?

  • Describe your documentation request.
    *The documentation for configuration of the Milliner component makes use of CRAYFISH_DB_xxx (USER/DB/PASSWORD which seems to be part of the gemini component that is no longer used. I cannot continue my manual installation any further due to this bug

  • Which version of islandora are you using?

  • 2.0

  • What user roles is this documentation intended for?

Administrator

  • What implementations of islandora does this documentation request apply to?
    2.0

Any related open or closed issues to this bug report?

Screenshots:

@rosiel
Copy link
Member

rosiel commented Oct 14, 2022

Oof, that's not a good look. Sorry you ran into that.

I know this is not helpful, but I have an open PR that adds a warning disclaimer to all the manual install instructions. We know they're broken, and so thank you for pointing out where.

What might be more useful is the ansible role that installs Crayfish (part of the Playbook). I have never done a manual install but, in theory at least, the ansible role should go through the same steps that a manual installation would. Some things might be different (locations, versions, etc).

@ysuarez ysuarez added the Type: documentation provides documentation or asks for documentation. label Nov 9, 2022
@ysuarez
Copy link
Contributor

ysuarez commented Nov 9, 2022

@robyj I just wanted to give you a non-update to your issue. We now have now added a warning at the top of that page so that people are not trying to use these out of date manual installation docs...

"...
Needs Maintenance

The manual installation documentation is in need of attention. We are aware that some components no longer work as documented here. If you are interested in helping us improve the documentation, please see Contributing.
..."

image

@ysuarez
Copy link
Contributor

ysuarez commented Dec 14, 2022

Should we close this issue?

@robyj
Copy link
Author

robyj commented Dec 14, 2022

Hi

I ended up asked jared whiklo about this issue and he said that those values aren't even being used and to ignore them. I continued and it seems to have worked.

I think you can close this issue. thanks for checking

Jon

@ysuarez
Copy link
Contributor

ysuarez commented Dec 17, 2022

Glad to hear it.

@ysuarez ysuarez closed this as completed Dec 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: documentation provides documentation or asks for documentation.
Projects
None yet
Development

No branches or pull requests

3 participants