improve docs

Author: leafty

backend/doi/api/inveniotypes.go

@@ -1,8 +1,8 @@
-// Type definitions specific to InvenioDRM
+// Type definitions specific to InvenioRDM
 
 package api
 
-// InvenioRecordResponse is the representation of a record stored in InvenioDRM
+// InvenioRecordResponse is the representation of a record stored in InvenioRDM
 type InvenioRecordResponse struct {
 	Links InvenioRecordResponseLinks `json:"links"`
 	// Metadata InvenioRecordMetadata      `json:"metadata"`

backend/doi/invenio.go

@@ -1,4 +1,4 @@
-// Implementation for InvenioDRM
+// Implementation for InvenioRDM
 
 package doi
 
@@ -18,13 +18,13 @@ import (
 
 var invenioRecordRegex = regexp.MustCompile(`\/records?\/(.+)`)
 
-// Returns true if resolvedURL is likely a DOI hosted on an InvenioDRM intallation
+// Returns true if resolvedURL is likely a DOI hosted on an InvenioRDM intallation
 func activateInvenio(ctx context.Context, srv *rest.Client, pacer *fs.Pacer, resolvedURL *url.URL) (isActive bool) {
 	_, _, err := resolveInvenioEndpoint(ctx, srv, pacer, resolvedURL)
 	return err == nil
 }
 
-// Resolve the main API endpoint for a DOI hosted on an InvenioDRM installation
+// Resolve the main API endpoint for a DOI hosted on an InvenioRDM installation
 func resolveInvenioEndpoint(ctx context.Context, srv *rest.Client, pacer *fs.Pacer, resolvedURL *url.URL) (provider Provider, endpoint *url.URL, err error) {
 	var res *http.Response
 	opts := rest.Opts{

docs/content/doi.md

@@ -6,10 +6,63 @@ versionIntroduced: "?"
 
 # {{< icon "fa fa-building-columns" >}} DOI
 
+The DOI remote is a read only remote for reading files from digital object identifiers (DOI).
+
+Currently, the DOI backend supports supports DOIs hosted with:
+- [InvenioRDM](https://inveniosoftware.org/products/rdm/)
+  - [Zenodo](https://zenodo.org)
+  - [CaltechDATA](https://data.caltech.edu)
+  - [Other InvenioRDM repositories](https://inveniosoftware.org/showcase/)
+- [Dataverse](https://dataverse.org)
+  - [Harvard Dataverse](https://dataverse.harvard.edu)
+  - [Other Dataverse repositories](https://dataverse.org/installations)
+
 Paths are specified as `remote:path`
 
 Paths may be as deep as required, e.g. `remote:directory/subdirectory`.
 
+## Configuration
+
+Here is an example of how to make a remote called `remote`.  First run:
+
+     rclone config
+
+This will guide you through an interactive setup process:
+
+```
+No remotes found, make a new one?
+n) New remote
+s) Set configuration password
+q) Quit config
+n/s/q> n
+Enter name for new remote.
+name> remote
+Type of storage to configure.
+Choose a number from below, or type in your own value
+[snip]
+XX / DOI datasets
+   \ (doi)
+[snip]
+Storage> doi
+Option doi.
+The DOI or the doi.org URL.
+Enter a value.
+doi> 10.5281/zenodo.5876941
+Edit advanced config?
+y) Yes
+n) No (default)
+y/n> n
+Configuration complete.
+Options:
+- type: doi
+- doi: 10.5281/zenodo.5876941
+Keep this "remote" remote?
+y) Yes this is OK (default)
+e) Edit this remote
+d) Delete this remote
+y/e/d> y
+```
+
 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/doi/doi.go then run make backenddocs" >}}
 ### Standard options
 
@@ -74,40 +127,11 @@ Show metadata about the DOI.
 
     rclone backend metadata remote: [options] [<arguments>+]
 
-This command returns the JSON representation of the DOI.
+This command returns a JSON object with some information about the DOI.
 
     rclone backend medatadata doi: 
 
-It returns a JSON object representing the DOI.
-
-
-### title
-
-Show the DOI title if available.
-
-    rclone backend title remote: [options] [<arguments>+]
-
-This command returns the DOI title.
-
-    rclone backend title doi: 
-
-It returns a string representing the DOI title.
-
-
-### provider
-
-Show the DOI provider.
-
-    rclone backend provider remote: [options] [<arguments>+]
-
-This command returns the DOI provider.
-
-    rclone backend provider doi: 
-
-This command can be used to update the rclone.conf file for faster operations with the doi backend
-as auto-detection for the provider can be avoided.
-
-It returns a string representing the DOI provider.
+It returns a JSON object representing metadata about the DOI.
 
 
 ### set