Skip to content

Commit 12a9ce1

Browse files
committed
[irods#1395] remove the manual, point to full documentation
1 parent 699b463 commit 12a9ce1

File tree

8 files changed

+6
-25
lines changed

8 files changed

+6
-25
lines changed

HOWTO_RELEASE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ From here, the automated system should take over and kick into gear.
4444

4545
Then, manually...
4646

47-
- upload new manual to irods.org
47+
- upload new documentation to irods.org
4848
- update irods.org/download
4949
- post announcement as irods.org blog post
5050
- post announcement to [email protected]

Makefile

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@ include VERSION
22

33
include ./iRODS/config/external_versions.txt
44

5-
MANUAL=irods-manual-$(IRODSVERSION).pdf
6-
75
MAKEFLAGS += --no-print-directory
86

9-
.PHONY : default all epm manual mkdocs squeaky_clean clean libs plugins plugins-nodb plugins-db code-generation irods external external-build docs doxygen icat icat-package icommands icommands-package resource resource-package resource
7+
.PHONY : default all epm mkdocs squeaky_clean clean libs plugins plugins-nodb plugins-db code-generation irods external external-build docs doxygen icat icat-package icommands icommands-package resource resource-package resource
108

119
default : external-build libs plugins irods
1210

@@ -55,13 +53,7 @@ code-generation : external
5553
irods : libs
5654
@$(MAKE) -C iRODS
5755

58-
docs : manual doxygen mkdocs
59-
60-
manual :
61-
@echo "Generating Manual..."
62-
@sed -e 's,TEMPLATE_IRODSVERSION,$(IRODSVERSION),' manual.rst > manual.tmp
63-
@rst2pdf manual.tmp -o $(MANUAL)
64-
@rm -f manual.tmp
56+
docs : doxygen mkdocs
6557

6658
doxygen :
6759
@echo "Generating Doxygen..."
@@ -85,7 +77,6 @@ clean :
8577
@$(MAKE) -C iRODS clean
8678
@$(MAKE) -C examples/microservices clean
8779
@$(MAKE) -C examples/resources clean
88-
@rm -f $(MANUAL)
8980
@rm -rf doxygen/html
9081
@rm -rf mkdocs/html
9182
@rm -rf docs/icommands

mkdocs.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,3 @@ markdown_extensions:
1010
- admonition
1111
- attr_list
1212
- def_list
13-
14-
#pages:
15-
# - [index.md, Home]
16-
# - [manual.md, The Manual]
17-
# - [developers.md, Some Developers and Stuff]
18-
# - [Rule_Language.md, ROOOOLS]

packaging/build.sh

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -490,8 +490,6 @@ if [ "$1" == "clean" ] ; then
490490
echo "Cleaning $SCRIPTNAME residuals..."
491491
rm -f changelog.gz
492492
rm -rf $MANDIR
493-
rm -f manual.pdf
494-
rm -f irods-manual*.pdf
495493
rm -f examples/microservices/*.pdf
496494
rm -f libirods_client.a
497495
rm -f libirods_server.a
@@ -639,7 +637,6 @@ if [ "$1" == "docs" ] ; then
639637
$EPMCMD -f pkg irods-docs $LISTFILE
640638
elif [ "$DETECTEDOS" == "MacOSX" ] ; then # MacOSX
641639
echo "${text_green}${text_bold}$DETECTEDOS - No packaging supported.${text_reset}"
642-
ls -l irods-manual*.pdf
643640
elif [ "$DETECTEDOS" == "ArchLinux" ] ; then # ArchLinux
644641
echo "${text_green}${text_bold}Running EPM :: Generating $DETECTEDOS TGZs${text_reset}"
645642
$EPMCMD -f portable irods-docs $LISTFILE

packaging/irods-docs.list.template

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,4 @@ $IRODS_DOC_DIR=/usr/share/doc/$IRODS_PACKAGENAME
2929
#f 644 root root ${IRODS_DOC_DIR}/doxygen ./iRODS/doc/html/*.js
3030

3131
d 755 root root ${IRODS_DOC_DIR} -
32-
f 644 root root ${IRODS_DOC_DIR}/irods-manual-TEMPLATE_IRODSVERSION.pdf ./irods-manual-TEMPLATE_IRODSVERSION.pdf
3332

packaging/setup_resource.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ if [ $# -eq 1 ] ; then
115115
# for devtest in the cloud
116116
perl ./scripts/perl/irods_setup.pl $1
117117
else
118-
# manual
118+
# by hand
119119
perl ./scripts/perl/irods_setup.pl
120120
fi
121121

packaging/user_icat.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This installation of an iCAT server is currently incomplete and
77
needs a database plugin to be installed and configured before
88
it can be started and used.
99

10-
Please consult the manual for further instructions.
10+
Please consult the documentation for further instructions.
1111

1212
=======================================================================
1313

packaging/user_resource.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This will result in a running resource server with a default
1414
resource named with your hostname concatenated with "Resource"
1515
and a local vault in /var/lib/irods/iRODS/Vault.
1616

17-
Please consult the manual for further configuration details.
17+
Please consult the documentation for further configuration details.
1818

1919
=======================================================================
2020

0 commit comments

Comments
 (0)