Skip to content

Commit 126a761

Browse files
committed
minor tweaks #10606
1 parent 10b6389 commit 126a761

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

doc/sphinx-guides/source/developers/dev-environment.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ After cloning the `dataverse repo <https://github.com/IQSS/dataverse>`_, run thi
1818

1919
``mvn -Pct clean package docker:run``
2020

21-
(Note that if you are Windows, you must run the command above in `WSL <https://learn.microsoft.com/windows/wsl>`_ rather than cmd.exe.)
21+
(Note that if you are Windows, you must run the command above in `WSL <https://learn.microsoft.com/windows/wsl>`_ rather than cmd.exe. See :doc:`windows`.)
2222

2323
After some time you should be able to log in:
2424

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@
22
Windows Development
33
===================
44

5-
5+
.. contents:: |toctitle|
6+
:local:
67

78
Running Dataverse in Windows WSL
89
--------------------------------
910

1011
The simplest method to run Dataverse in Windows 10 and 11 is using Docker and Windows Subsystem for Linux (WSL) - specifically WSL 2.
11-
Once Docker and WSL are installed, you can follow the :ref:`Quickstart instructions <container-dev-quickstart>`.
12+
Once Docker and WSL are installed, you can follow the :ref:`quickstart instructions <container-dev-quickstart>`.
1213

1314
Please note: these instructions have not been extensively tested. They have been found to work with the Ubuntu-24.04 distribution for WSL. If you find any problems, please open an issue at https://github.com/IQSS/dataverse/issues and/or submit a PR to update this guide.
1415

1516
Install Docker Desktop
1617
~~~~~~~~~~~~~~~~~~~~~~
1718

18-
Follwow the directions at https://www.docker.com/ to install Docker Desktop on Windows. If prompted, turn on WSL 2 during installation.
19+
Follow the directions at https://www.docker.com to install Docker Desktop on Windows. If prompted, turn on WSL 2 during installation.
1920

2021
Settings you may need in Docker Desktop:
2122

@@ -29,7 +30,7 @@ Install WSL
2930
~~~~~~~~~~~
3031
If you install Docker Desktop, you should already have WSL installed. If not, or if you wish to add an additional Linux distribution, open PowerShell.
3132

32-
If wsl itself is not installed run:
33+
If WSL itself is not installed run:
3334

3435
.. code-block:: powershell
3536
@@ -61,20 +62,19 @@ You will be asked to create an initial Linux user.
6162
Install Dataverse
6263
~~~~~~~~~~~~~~~~~
6364

64-
Open a Linux terminal (e.g. use Windows Terminal and open a tab for the Linux distribution you selected). Then install Dataverse in WSL following the ``Quickstart`` instructions in :doc:`dev-environment`. You should then have a working Dataverse instance.
65+
Open a Linux terminal (e.g. use Windows Terminal and open a tab for the Linux distribution you selected). Then install Dataverse in WSL following the :ref:`quickstart instructions <container-dev-quickstart>`. You should then have a working Dataverse instance.
6566

6667
IDEs for Dataverse in Windows
6768
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6869

6970
You can use your favorite editor or IDE to edit Dataverse project files. Files in WSL are accessible from Windows for editing using the path ``\\wsl.localhost``. Your Linux distribution files should also be visible in File Explorer under the This PC/Linux entry.
7071
FYI: For the best performance, it is recommended, with WSL 2, to store Dataverse files in the WSL/Linux file system and to access them from there with your Windows-based IDE (versus storing Dataverse files in your Windows file system and trying to run maven and build from Linux - access to /mnt/c files using WSL 2 is slow).
7172

72-
7373
pgAdmin in Windows for Dataverse
7474
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7575

7676
You can access the Dataverse database from Windows.
7777

7878
Install pgAdmin from https://www.pgadmin.org/download/pgadmin-4-windows/
7979

80-
In pgAdmin, register a server using ``127.0.0.1`` with port ``5432``, database ``dvndb``, and, by default, username ``dataverse`` password ``secret``. Now you will be able to access, monitor, and update the Dataverse database.
80+
In pgAdmin, register a server using ``127.0.0.1`` with port ``5432``. For the database name, username, and password, see :ref:`db-name-creds`. Now you will be able to access, monitor, and update the Dataverse database.

0 commit comments

Comments
 (0)