solichecks.blogg.se

1. #OWNCLOUD DOCUMENTATION PDF#
2. #OWNCLOUD DOCUMENTATION INSTALL#
3. #OWNCLOUD DOCUMENTATION MANUAL#
4. #OWNCLOUD DOCUMENTATION FULL#
5. #OWNCLOUD DOCUMENTATION FREE#

We hope that you can see that contributing to the documentation using Antora is a pretty straight-forward process, and not that demanding. Your changes will be reflected in the local version of the site that Serve is rendering. If you're not satisfied, continue to work on the file(s) and start the build process again. If you're happy with your changes, create a set of meaningful commits and push them to the remote repository. For owncloud Server, select master as you usually start working there.

#OWNCLOUD DOCUMENTATION MANUAL#

In this case, you have to select the manual to view on the left side of the browser window. NOTE: You will likely get a screen with the message "Page not found". This starts a simple webserver, using the public directory, (re)generated by antora, as the document root, listening on Open the URL in your browser of choice and you'll see two links, as below. The following example uses our Yarn target, to start it run the following command in the root of your docs repository:

You could also use PHP's built-in webserver as well. If you have already installed a webserver, you need to make the HTML documentation available pointing to subdirectory public or for easy handling use our predefined Yarn target so that you can view your changes, before committing and pushing the changes to the remote docs repository. Unable to find image 'owncloudci/nodejs:14' locally 14: Pulling from owncloudci/nodejs 3b37166ec614: Already exists 504facff238f: Already exists ebbcacd28e10: Already exists c7fb3351ecad: Already exists 2e3debadcbf7: Already exists a5aa5acbbb21: Already exists fec54bf92721: Already exists 37568f2dfa71: Pull complete cec1230fab6b: Pull complete 08e882bea23f: Pull complete 78bc608ac308: Pull complete Digest: sha256:d7706c693242c65b36b3205a52483d8aa567d09a1465707795d9273c0a99c0c2 Status: Downloaded newer image for owncloudci/nodejs:14 Viewing the HTML DocumentationĪssuming that there are no errors, the next thing to do is to view the result in your browser.

#OWNCLOUD DOCUMENTATION FULL#

For a quick view on the changes made and without having a full build, you can open the changed file in the browser and view it with the installed plug-in which helps finding typos and/or rendering issues quickly. If you push a change with errors, the CI will complain in the Pull request and disallow any merging.

#OWNCLOUD DOCUMENTATION FREE#

Note that the build process is essential as it must run error free for a valid documentation. This project has a predefined target ( antora) which calls Antora, supplying all of the required options to build the docs, to build the documentation on any branch of the ownCloud documentation repository. Using Yarn, as in the example below, is the easiest way to build the documentation.

#OWNCLOUD DOCUMENTATION PDF#

The documentation can be generated in HTML and PDF formats. See also: Overwrite the Default URL below. The difference when running antora versus antora-local is that the latter command already defines localhost as URL where the documentation is displayed. Question Which command would you like to run?:įor more information about the the yarn run command. generator/xref-validator.js -clean -fetch -attribute format=html site.yml generator/generate-site.js -clean -fetch -attribute format=html -url site.ymlīroken-link-checker -filter-level 3 -recursive -verboseĪntora -stacktrace generate -cache-dir cache -redirect-facility disabled -generator. generator/generate-site.js -clean -fetch -attribute format=html site.ymlĪntora -stacktrace generate -cache-dir cache -redirect-facility static -generator. Info Commands available from binary scripts: antora, blc, broken-link-checker, crc32, ecstatic, errno, esparse, esvalidate, handlebars, he, hs, http-server, isogit, js-yaml, json5, mime, mkdirp, nopt, opener, os-name, osx-release, printj, semver, sha.js, strip-ansi, supports-color, uglifyjs, write-good, writegoodĪntora -stacktrace generate -cache-dir cache -redirect-facility disabled -generator. To see all, prepared yarn commands run the following command:

The result shown in the browser may therefore look slightly different to a version that is built via yarn antora-local, but is a good start to catch first typos. Note, that rendering in the browser will not properly resolve global variables declared in e.g. Post installing, check that accessing local files in the plugin settings is allowed.

#OWNCLOUD DOCUMENTATION INSTALL#

You may use the Asciidoctor.js Live Preview or any other that is available for your browser - just search and install a suitable one. Therefore you can install a plugin for your browser to render. It is very helpful to see how changes to a section will render. With the dependencies installed, you are now ready to build (generate) the ownCloud documentation. Sudo apt-get install libgraphicsmagick1-dev