add make joss

Author: CunliangGeng

Makefile

@@ -1,5 +1,5 @@
 # .PHONY is used to declare that the targets are not files
-.PHONY: install-dev clean clean-build clean-pyc clean-test clean-doc release build update-version sync-webapp-readme build-docs deploy-docs
+.PHONY: install-dev clean clean-build clean-pyc clean-test clean-doc release build update-version sync-webapp-readme build-docs deploy-docs joss
 
 help:
 	@echo "Available commands to 'make':"
@@ -14,6 +14,7 @@ help:
 	@echo "  build-docs    : build documentation for local development"
 	@echo "  deploy-docs   : deploy documentation to GitHub Pages"
 	@echo "  update-version: update NPLinker version (e.g. make update-version CURRENT_VERSION=0.1.0 NEW_VERSION=0.2.0)"
+	@echo "  joss          : compile JOSS paper from markdown to PDF for previewing"
 
 install-dev:	
 	pip install -e ".[dev]"
@@ -93,4 +94,12 @@ deploy-docs: sync-webapp-readme
 ifndef version
 	$(error version is not set. Usage: make deploy-docs version=YOUR_VERSION)
 endif
-	mike deploy -p -u $(version) latest
+	mike deploy -p -u $(version) latest
+
+joss: 
+	@docker info > /dev/null 2>&1 || { echo >&2 "Docker is not running. Please start Docker and try again."; exit 1; }
+	docker run --rm \
+		--volume ${PWD}/joss:/data \
+		--user $(id -u):$(id -g) \
+		--env JOURNAL=joss \
+		openjournals/inara

README.dev.md

@@ -242,4 +242,20 @@ After creating a new release, you can publish the docs for the new version with
 make deploy-docs version=2.0.3 
 ```
 
-this will deploy the docs for the new version and mark it as the latest version. You can check the [docs page](https://nplinker.github.io/nplinker/) to see the new version of the docs.
+this will deploy the docs for the new version and mark it as the latest version. You can check the [docs page](https://nplinker.github.io/nplinker/) to see the new version of the docs.
+
+
+## Preview the JOSS (Journal of Open Source Software) paper
+
+You can preview the JOSS PDF paper with the following command:
+
+```shell
+cd path-to-nplinker-repo
+
+# ensure docker is running before executing the command
+make joss
+```
+
+This command will convert the JOSS paper from [markdown](./joss/paper.md) to a PDF. Preview the PDF to make sure everything looks good before committing the changes of the markdown file. 
+
+After you push the changes of the markdown file to the remote repository, a Github action will automatically generate the PDF from the markdown file and commit it to the `joss` directory.