Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
sashakames committed Jul 1, 2024
1 parent 90bc958 commit ea1b1cb
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The esgcet package for ESGF Publication - Version 5.2.2
The esgcet package for ESGF Publication - Version 5.2.3
=======================================================

Esgcet is a package of publisher commands for publishing to the `ESGF
Expand All @@ -13,7 +13,7 @@ If you have conda on a Linux system you can install the publisher wih the follow
conda create -n esgf-pub -c conda-forge pip cmor # most commun
conda activate esgf-pub
pip install esgcet
esgpublish --version # Ensure you have upgraded to v5.2.1
esgpublish --version # Ensure you have upgraded to v5.2.3
esgpublish # will print the usage information.


Expand Down
5 changes: 2 additions & 3 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Use the following command to install ``esgcet`` into a previously created conda

conda activate esgf-pub
pip install esgcet
esgpublish --version # Ensure you have upgraded to v5.2.1
esgpublish --version # Ensure you have upgraded to v5.2.3


Installing esgcet via git
Expand All @@ -34,10 +34,9 @@ To install esgcet by cloning our github repository (useful if you want to modiy

git clone http://github.com/ESGF/esg-publisher.git
cd esg-publisher
git checkout refactor-esgf # NOTE this is a temporary fix prior to a merge into the master branch
cd src/python
pip install -e . # You can modify the source in place
esgpublish --version # Confirm that v5.2.1 has been installed
esgpublish --version # Confirm that v5.2.3 has been installed

Now you will be able to call all commands in this package from any directory.

Expand Down
5 changes: 5 additions & 0 deletions docs/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,8 @@ If you encounter issues running any of the esgcet commands, try looking for comm
feel free to open a github issue and request that support for your project is added.
- For example commands and test scripts, see our `test suite repository <https://github.com/lisi-w/test-suite/tree/main>`_.
- For unexpected behavior, output, or errors, please open a `Github Issue <https://github.com/ESGF/esg-publisher/issues>`_.

Known issues
------------

* There is a problem identified with esgunpublish and connecting to the PID server. Please report if you need support and a team member will assist.
10 changes: 10 additions & 0 deletions docs/whatsnew.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Release Notes
=============

v5.2.3
------

* Update argument processing to make ``--cert`` an optional argument to align with changes in ESGF architecture
* Bugfixes to support optional citation and further info URLs
* Support of customized ``https_url`` in the configuration for non- ``thredds/fileServer`` endpoints.
* Introduction of ``globus_url`` inclusion for direct link to the Globus file manager.
* **BUGFIX** for a default ``esg.yaml`` under the ``.esg`` hidden directory


v5.2.2
------

Expand Down

0 comments on commit ea1b1cb

Please sign in to comment.