Skip to content

Added 'clean' target for makefile #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 7, 2022
Merged

Added 'clean' target for makefile #235

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
54181c7
Changed cache dir and added clean target
Jul 7, 2022
25d0e43
Updated gitignore
Jul 7, 2022
fed081a
Added trailing newline
Jul 7, 2022
ed24f42
Update Makefile
fhennig Jul 7, 2022
5839296
Merge branch 'main' into make-clean
fhennig Jul 7, 2022
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated gitignore
  • Loading branch information
Felix Hennig committed Jul 7, 2022
commit 25d0e43238cf2558d0eea89fad0337b25ca5324d
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
build/
cache/
.idea/
node_modules/
6 changes: 3 additions & 3 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
:base-repo: https://github.com/stackabletech

This is the main repository for the documentation of the Stackable platform.
It uses https://antora.org[Antora].
Have a look at the https://docs.stackable.tech/[live version].

This repository hosts the Antora playbook file as well as some generic documentation modules.
The documentation is built with https://antora.org[Antora]. This repository hosts the Antora playbook file as well as platform documentation. Other Stackable repos contain 'docs' directories which are pulled in by this repo.

To build the site, pull submodules, install dependencies and run `make`:

Expand All @@ -17,7 +17,7 @@ $ npm ci
$ make
----

NOTE: Antora caches all resources it downloads in the user's cache directory (e.g. `~/.cache/antora` directory on Linux). It will _not_ automatically update those. Use the `--fetch` flag (`make ANTORAFLAGS=--fetch`) to update all sources.
NOTE: Antora caches the external content repos in the cache directory (configured to be `./cache`). It will _not_ automatically update those. Use the `--fetch` flag (`make ANTORAFLAGS=--fetch`) to update all sources, or use `make clean` to delete the `cache` and `build` directory.

== Development

Expand Down