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

Update info in Dataverse Developers Guide about what happens when not specifying a branch when running script that deploys Dataverse on AWS #10572

Closed
jggautier opened this issue May 17, 2024 · 4 comments · Fixed by #10589
Labels
Feature: Developer Guide User Role: Sysadmin Installs, upgrades, and configures the system, connects via ssh
Milestone

Comments

@jggautier
Copy link
Contributor

jggautier commented May 17, 2024

What's written in the "Download and Run the “Create Instance” Script" section of Dataverse's Developer Guide needs to be updated.

Screenshot 2024-05-17 at 3 31 28 PM

If you don't specify a branch, the script doesn't default to the develop branch but to the latest release of Dataverse, such as v6.2 if that's the latest release.

Should we change the line:

-b: branch to build (defaults to develop)

to this?:

-b: branch to build (defaults to the latest release of Dataverse)

This section is in the Developers guide, on its Deployment page at https://github.com/IQSS/dataverse/blob/develop/doc/sphinx-guides/source/developers/deployment.rst

@jggautier jggautier added Feature: Developer Guide User Role: Sysadmin Installs, upgrades, and configures the system, connects via ssh labels May 17, 2024
@pdurbin
Copy link
Member

pdurbin commented May 17, 2024

It's definitely a good idea to revisit this page. I was showing it to @jp-tosca this week and basically said, "Ignore all this. I don't know if it's still accurate. Run the script with -h to print the help instead." 😅

@jggautier
Copy link
Contributor Author

@pdurbin, then should you broaden the scope of this issue by changing its title and description? As far as I know the only update needed is about the default branch.

Or can you open a new issue about revisiting this page? Then for this GitHub issue I could made a PR to update that part about the default branch. Since it would be a small documentation change, I was thinking that we could squeeze it in this sprint.

@pdurbin
Copy link
Member

pdurbin commented May 23, 2024

Sure, we can keep the focus small, just on explaining what happens when -b is omitted.

@jggautier
Copy link
Contributor Author

Okay the PR at #10589 updates that line to read that by default the branch used is the latest release of Dataverse.

Feel free to create an issue about revisiting this page. Like I wrote, as far as I know, everything else is accurate. But I'm sure @jp-tosca and maybe others have needed different info that's on the page because they've deployed Dataverse instances for reasons that are different from mine. Maybe revisiting the page could involve others trying to use this page to see what isn't accurate and needs to be updated.

@jggautier jggautier changed the title Update info in Developer Guide about default branch used by script that deploys Dataverse on AWS Update info about what happens when not specifying a branch when running script that deploys Dataverse on AWS May 24, 2024
@jggautier jggautier changed the title Update info about what happens when not specifying a branch when running script that deploys Dataverse on AWS Update info in Dataverse Developers Guide about what happens when not specifying a branch when running script that deploys Dataverse on AWS May 24, 2024
@pdurbin pdurbin added this to the 6.3 milestone Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Developer Guide User Role: Sysadmin Installs, upgrades, and configures the system, connects via ssh
Projects
None yet
2 participants