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

[QA] Update EOS dev docs #898

Closed
jnweiger opened this issue Nov 19, 2020 · 1 comment
Closed

[QA] Update EOS dev docs #898

jnweiger opened this issue Nov 19, 2020 · 1 comment

Comments

@jnweiger
Copy link
Contributor

In order to provide better service to the BTR team, useful documentation should be provided.
The current documentation at docs/ocis/eos.md (https://owncloud.github.io/ocis/eos) is outdated.

  • It discusses a setup using ocis/docker-compose.yml with 6 additional steps.
  • This setup fails since RC1
  • It does not address remote access.

For QA, a dedicated ocis/docker-compose-eos-test.yml is provided, that should not need additional steps for localhost testing.

The documentation should

  • mention ocis/docker-compose-eos-test.yml and explain its usage. For RC5 testing, the BTR team currently uses

    cd ocis/ocis
    checkout master
    cp docker-compose-eos-test.yml master-docker-compose-eos-test.yml
    checkout v1.0.0-rc5
    env EOS_OCIS_TAG=1.0.0-rc5 BRANCH=v1.0.0-rc5 docker-compose -f master-docker-compose-eos-test.yml up -d
    

    This uses docker images from https://hub.docker.com/search?q=owncloud%2Feos&type=image
    and only works on localhost. (Mobile client testing is thus blocked)

  • have steps for remote deployment. E.g. provide a template for identifier-registration.yml

  • discuss eos deployment options. E.g. Single host or cluster.

  • list the demo instance maintained by the team for testing.

  • The scope of ocis/docker-compose.yml should be clarified: localhost only, no eos.

Earlier issue: #361 Afaik, most of the items there are no longer relevant -- review needed.

@stale
Copy link

stale bot commented Mar 14, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 10 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status:Stale label Mar 14, 2021
@stale stale bot closed this as completed Mar 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants