Skip to content

Commit 79e5636

Browse files
authored
Merge pull request #11849 from Maham802/patch-1
docs: update dataverse-ansible links in guides
2 parents 08b9ec6 + 8269788 commit 79e5636

File tree

5 files changed

+14
-14
lines changed

5 files changed

+14
-14
lines changed

doc/sphinx-guides/source/admin/monitoring.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Tips:
149149
- Use **Enhanced Monitoring**. Enhanced Monitoring gathers its metrics from an agent on the instance. See `Enhanced Monitoring docs <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html>`_.
150150
- It's possible to view and act on **RDS Events** such as snapshots, parameter changes, etc. See `Working with Amazon RDS events <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.access-control.html>`_ for details.
151151
- RDS monitoring is available via API and the ``aws`` command line tool. For example, see `Retrieving metrics with the Performance Insights API <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.API.html>`_.
152-
- To play with monitoring RDS using a server configured by `dataverse-ansible <https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible>`_ set ``use_rds`` to true to skip some steps that aren't necessary when using RDS. See also the :doc:`/developers/deployment` section of the Developer Guide.
152+
- To play with monitoring RDS using a server configured by `dataverse-ansible <https://github.com/gdcc/dataverse-ansible>`_ set ``use_rds`` to true to skip some steps that aren't necessary when using RDS. See also the :doc:`/developers/deployment` section of the Developer Guide.
153153

154154
MicroProfile Metrics endpoint
155155
-----------------------------

doc/sphinx-guides/source/api/external-tools.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ Testing Your External Tool
202202

203203
As the author of an external tool, you are not expected to learn how to install and operate a Dataverse installation. There's a very good chance your tool can be added to a server Dataverse Community developers use for testing if you reach out on any of the channels listed under :ref:`getting-help-developers` in the Developer Guide.
204204

205-
By all means, if you'd like to install a Dataverse installation yourself, a number of developer-centric options are available. For example, there's a script to spin up a Dataverse installation on EC2 at https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible . The process for using curl to add your external tool to your Dataverse installation is documented under :ref:`managing-external-tools` in the Admin Guide.
205+
By all means, if you'd like to install a Dataverse installation yourself, a number of developer-centric options are available. For example, there's a script to spin up a Dataverse installation on EC2 at https://github.com/gdcc/dataverse-ansible . The process for using curl to add your external tool to your Dataverse installation is documented under :ref:`managing-external-tools` in the Admin Guide.
206206

207207
Spreading the Word About Your External Tool
208208
-------------------------------------------
@@ -219,7 +219,7 @@ If you've thought to yourself that there ought to be an app store for Dataverse
219219
Demoing Your External Tool
220220
++++++++++++++++++++++++++
221221

222-
https://demo.dataverse.org is the place to play around with the Dataverse Software and your tool can be included. Please email [email protected] to start the conversation about adding your tool. Additionally, you are welcome to open an issue at https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible which already includes a number of the tools listed above.
222+
https://demo.dataverse.org is the place to play around with the Dataverse Software and your tool can be included. Please email [email protected] to start the conversation about adding your tool. Additionally, you are welcome to open an issue at https://github.com/gdcc/dataverse-ansible which already includes a number of the tools listed above.
223223

224224
Announcing Your External Tool
225225
+++++++++++++++++++++++++++++

doc/sphinx-guides/source/developers/deployment.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Amazon offers instructions on using an IAM role to grant permissions to applicat
7878
Configure Ansible File (Optional)
7979
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8080

81-
In order to configure Dataverse installation settings such as the password of the dataverseAdmin user, download https://raw.githubusercontent.com/GlobalDataverseCommunityConsortium/dataverse-ansible/master/defaults/main.yml and edit the file to your liking.
81+
In order to configure Dataverse installation settings such as the password of the dataverseAdmin user, download https://raw.githubusercontent.com/gdcc/dataverse-ansible/develop/defaults/main.yml and edit the file to your liking.
8282

8383
You can skip this step if you're fine with the values in the "main.yml" file in the link above.
8484

@@ -89,7 +89,7 @@ Once you have done the configuration above, you are ready to try running the "ec
8989

9090
Download `ec2-create-instance.sh`_ and put it somewhere reasonable. For the purpose of these instructions we'll assume it's in the "Downloads" directory in your home directory.
9191

92-
.. _ec2-create-instance.sh: https://raw.githubusercontent.com/GlobalDataverseCommunityConsortium/dataverse-ansible/master/ec2/ec2-create-instance.sh
92+
.. _ec2-create-instance.sh: https://raw.githubusercontent.com/gdcc/dataverse-ansible/develop/ec2/ec2-create-instance.sh
9393

9494
To run the script, you can make it executable (``chmod 755 ec2-create-instance.sh``) or run it with bash, like this with ``-h`` as an argument to print the help:
9595

doc/sphinx-guides/source/developers/testing.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ You might find studying the following test classes helpful in writing tests for
128128
- DeletePrivateUrlCommandTest.java
129129
- GetPrivateUrlCommandTest.java
130130

131-
In addition, there is a writeup on "The Testable Command" at https://github.com/IQSS/dataverse/blob/develop/doc/theTestableCommand/TheTestableCommand.md .
131+
In addition, there is a writeup on "The Testable Command" at https://github.com/IQSS/dataverse/blob/master/doc/theTestableCommand/TheTestableCommand.md .
132132

133133
Running Non-Essential (Excluded) Unit Tests
134134
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -169,12 +169,12 @@ different people. For our purposes, an integration test can have two flavors:
169169
Running the Full API Test Suite Using EC2
170170
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171171

172-
**Prerequisite:** To run the API test suite in an EC2 instance you should first follow the steps in the :doc:`deployment` section to get set up with the AWS binary to launch EC2 instances. If you're here because you just want to spin up a branch, you'll still want to follow the AWS deployment setup steps, but may find the `ec2-create README.md <https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible/blob/master/ec2/README.md>`_ Quick Start section helpful.
172+
**Prerequisite:** To run the API test suite in an EC2 instance you should first follow the steps in the :doc:`deployment` section to get set up with the AWS binary to launch EC2 instances. If you're here because you just want to spin up a branch, you'll still want to follow the AWS deployment setup steps, but may find the `ec2-create README.md <https://github.com/gdcc/dataverse-ansible/blob/develop/ec2/README.md>`_ Quick Start section helpful.
173173

174-
You may always retrieve a current copy of the ec2-create-instance.sh script and accompanying group_var.yml file from the `dataverse-ansible repo <https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible/>`_. Since we want to run the test suite, let's grab the group_vars used by Jenkins:
174+
You may always retrieve a current copy of the ec2-create-instance.sh script and accompanying group_var.yml file from the `dataverse-ansible repo <https://github.com/gdcc/dataverse-ansible/>`_. Since we want to run the test suite, let's grab the group_vars used by Jenkins:
175175

176-
- `ec2-create-instance.sh <https://raw.githubusercontent.com/GlobalDataverseCommunityConsortium/dataverse-ansible/master/ec2/ec2-create-instance.sh>`_
177-
- `jenkins.yml <https://raw.githubusercontent.com/GlobalDataverseCommunityConsortium/dataverse-ansible/master/tests/group_vars/jenkins.yml>`_
176+
- `ec2-create-instance.sh <https://raw.githubusercontent.com/gdcc/dataverse-ansible/develop/ec2/ec2-create-instance.sh>`_
177+
- `jenkins.yml <https://raw.githubusercontent.com/gdcc/dataverse-ansible/develop/tests/group_vars/jenkins.yml>`_
178178

179179
Edit ``jenkins.yml`` to set the desired GitHub repo and branch, and to adjust any other options to meet your needs:
180180

@@ -184,7 +184,7 @@ Edit ``jenkins.yml`` to set the desired GitHub repo and branch, and to adjust an
184184
- ``dataverse.unittests.enabled: true``
185185
- ``dataverse.sampledata.enabled: true``
186186

187-
If you wish, you may pass the script a ``-l`` flag with a local relative path in which the script will `copy various logs <https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible/blob/master/ec2/ec2-create-instance.sh#L185>`_ at the end of the test suite for your review.
187+
If you wish, you may pass the script a ``-l`` flag with a local relative path in which the script will `copy various logs <https://github.com/gdcc/dataverse-ansible/blob/develop/ec2/ec2-create-instance.sh>`_ at the end of the test suite for your review.
188188

189189
Finally, run the script:
190190

@@ -526,7 +526,7 @@ Browser-Based Testing
526526
Installation Testing
527527
~~~~~~~~~~~~~~~~~~~~
528528

529-
- Work with @donsizemore to automate testing of https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible
529+
- Work with @donsizemore to automate testing of https://github.com/gdcc/dataverse-ansible
530530

531531
Future Work on Load/Performance Testing
532532
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -538,4 +538,4 @@ Future Work on Load/Performance Testing
538538
Future Work on Accessibility Testing
539539
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
540540

541-
- Using https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible and hooks available from accessibility testing tools, automate the running of accessibility tools on PRs so that developers will receive quicker feedback on proposed code changes that reduce the accessibility of the application.
541+
- Using https://github.com/gdcc/dataverse-ansible and hooks available from accessibility testing tools, automate the running of accessibility tools on PRs so that developers will receive quicker feedback on proposed code changes that reduce the accessibility of the application.

doc/sphinx-guides/source/installation/prep.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Advanced Installation
2626

2727
There are some community-lead projects to use configuration management tools such as Ansible and Puppet to automate the installation and configuration of the Dataverse Software, but support for these solutions is limited to what the Dataverse Community can offer as described in each project's webpage:
2828

29-
- https://github.com/GlobalDataverseCommunityConsortium/dataverse-ansible
29+
- https://github.com/gdcc/dataverse-ansible
3030
- https://gitlab.com/lip-computing/dataverse
3131
- https://github.com/IQSS/dataverse-puppet
3232

0 commit comments

Comments
 (0)