Skip to content
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.

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

Monorepo for documentation site #7

Merged
merged 17 commits into from
Jul 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
build/
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@

# Decidim Documentation

This is the new repository for the [Decidim Documentation website](https://antora.org/):

Is built with [Antora](https://antora.org/), although for this version we're going to try to not have multi-repositories, as it's a hassle to work with. The idea is to have all the documents living on this same repository.

This project is on active development and it's not on production yet.

For working with it, you can do it several ways:

## Install locally

### Manually

##### [Install antora](https://docs.antora.org/antora/2.3/install-and-run-quickstart/) with software dependencies.

```bash
# Install Node & npm using nvm
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
nvm install node

# Install Antora Command Line Interface (cli)
sudo npm i -g @antora/cli @antora/site-generator-default
```

If antora installation succeed, `antora -v` will return antora's version.

##### Clone repository and build documentation website.

```bash
git clone https://github.com/decidim/docs-base
cd docs-base
antora antora-playbook.yml
```

Website source code will be create under ```docs-base/build/site/decidim``` folder. Serve ```index.html``` with any application or http server.

```bash
xdg-open build/site/decidim/index.html
```

### Docker

You can check this locally and install with Docker.

```bash
git clone https://github.com/decidim/docs-base
cd docs-base
docker run -u $(id -u) -v $PWD:/antora:Z --rm -t antora/antora antora-playbook.yml
xdg-open build/site/decidim/index.html
```

## Roadmap

This is a work in progress. This will be on production when we finish all the issues on the [MVP Milestone](https://github.com/decidim/docs-base/milestone/1).
16 changes: 16 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
site:
title: Decidim Docs
url: https://docs.decidim.org
start_page: master@decidim:ROOT:index.adoc
content:
sources:
- url: &landing .
branches: [HEAD]
start_path: /en
ui:
bundle:
url: https://github.com/decidim/documentation-antora-ui/releases/download/v0.1/ui-bundle.zip
snapshot: true



102 changes: 0 additions & 102 deletions ca/modules/ROOT/partials/doc-info.adoc

This file was deleted.

39 changes: 0 additions & 39 deletions ca/modules/contributing/pages/docs/authorship-criteria.adoc

This file was deleted.

20 changes: 18 additions & 2 deletions en/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
= Decidim Documentation
include::decidim::partial$l10n.adoc[]

This is the documentation site for Decidim.
This is the documentation site to Decidim, a participatory democracy platform created initially by Barcelona City Hall.

== New to Decidim?

You’ve found the documentation for Decidim.

* Learn about the project at decidim.org[decidim.org].

* Read the xref:getting-started.adoc[Getting Started guide]

The documentation covers xref:installing.adoc[installing], xref:customising.adoc[customising], and xref:running.adoc[running] your own Decidim site.

If you’re making changes to the source code, we have documentation for xref:developing.adoc[developers] too.

If you are an organisation who wants to use Decidim, or a developer who is interested in collaborating on the software, please https://decidim.org/contact[get in touch].

Decidim is a community effort, as such if you find any errors on these guides please let us know at hola [at] decidim [dot] org. Every help is welcome. If you're tech savy you can even make a Pull Request through GitHub to help us improve this website.

Loading