Commit ef04bf89 authored by Francisco-Javier Ramon Salguero's avatar Francisco-Javier Ramon Salguero
Browse files

Documentation of all-in-one procedure and minor bugfix in script

parent 86540f33
Loading
Loading
Loading
Loading
+16 −1
Original line number Diff line number Diff line
@@ -31,10 +31,25 @@ make html
./fix_cross_references.sh 
```

The generated HTML output is stored in `_build/html`. You can go to that folder and publish the content locally with a Simple HTTP Server in Python.
The generated HTML output is stored in `_build/html`.

## Local publication

You can go to that folder and publish the content locally with a Simple HTTP Server in Python:

```bash
python3 -m http.server <PORT>
```

Then you can check the generated HTML output with a local web browser pointing to <http://localhost:PORT>

## Publication in ETSI OSM site

For regular publication in ETSI site, there is a all-in-one script that is highly convenient for regular or automated use, since builds the HTML documents and uploads them to the FTP in a single step (it also performs a backup for safety):

```bash
./upload-doc.sh
```

The script searchs for authorized EOL credentials in `local/.credentials`. In case the file does not exist, the user is prompted for valid EOL username and password.
+1 −1
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ make html
#
# Get credentias (file or interactive)
#
if [ local/.credentials ]; then
if [ -f local/.credentials ]; then
	source local/.credentials
	echo SERVER=${SERVER}
	echo USERNAME=${USERNAME}