Skip to content

Commit 4215b6a

Browse files
clsourceclsource
committed
reverted docs
1 parent 966fafb commit 4215b6a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1998
-3
lines changed

‎.github/workflows/antora-build.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Publish Antora docs to GitHub Pages
22
on:
33
push:
4-
branches: [docs]
4+
branches: [main]
55
# Allows you to run this workflow manually from the Actions tab
66
workflow_dispatch:
77
concurrency:
@@ -28,7 +28,7 @@ jobs:
2828
with:
2929
node-version: '18'
3030
- name: Install Antora
31-
run: npm i antora
31+
run: npm i antora asciidoctor-emoji asciidoctor-kroki @antora/lunr-extension
3232
- name: Generate Site
3333
run: npx antora antora-playbook.yml
3434
- name: Upload Artifacts

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: antora.build antora.server dev.shell dev.services mix.deps mix.setup mix.phoenix.server
1+
.PHONY: dev.shell dev.services mix.deps mix.setup mix.phoenix.server
22

33
# Devenv Commands
44
dev.shell dsh:

‎antora-playbook.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
site:
2+
title: Tololo Docs
3+
url: https://elixircl.github.io/tololo
4+
start_page: "tololo::index.adoc"
5+
6+
content:
7+
sources:
8+
- url: .
9+
branches: HEAD
10+
start_path: docs/
11+
12+
antora:
13+
extensions:
14+
- require: '@antora/lunr-extension'
15+
16+
asciidoc:
17+
extensions:
18+
- asciidoctor-emoji
19+
- asciidoctor-kroki
20+
attributes:
21+
kroki-fetch-diagram: true
22+
experimental: ''
23+
idprefix: ''
24+
idseparator: '-'
25+
page-pagination: ''
26+
highlightjs-theme: monokai
27+
highlightjs-languages: js, elixir, sql, yaml
28+
29+
ui:
30+
bundle:
31+
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
32+
snapshot: true
33+
# https://gitlab.com/antora/antora-ui-default/-/tree/master/src/partials
34+
supplemental_files: supplemental-ui/
35+
36+
output:
37+
dir: _dist

‎docs/.devcontainer.json

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"customizations": {
3+
"vscode": {
4+
"extensions": [
5+
"mkhl.direnv"
6+
]
7+
}
8+
},
9+
"image": "ghcr.io/cachix/devenv:latest",
10+
"overrideCommand": false,
11+
"updateContentCommand": "devenv test"
12+
}

‎docs/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_dist/

‎docs/Makefile

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.PHONY: antora.build antora.server shell
2+
3+
shell s:
4+
@devenv shell
5+
6+
antora.build b:
7+
@rm -rf ./_dist
8+
@antora ../antora-playbook.yml
9+
@touch ./_dist/.nojekyll
10+
11+
antora.server as:
12+
@make antora.build
13+
@npm run serve

‎docs/antora.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: tololo
2+
version: ~
3+
title: Tololo Ecommerce
4+
nav:
5+
- modules/ROOT/nav.adoc
6+
- modules/decisions/nav.adoc
7+
- modules/developer/nav.adoc
8+
- modules/requirements/nav.adoc

‎docs/devenv.lock

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
{
2+
"nodes": {
3+
"devenv": {
4+
"locked": {
5+
"dir": "src/modules",
6+
"lastModified": 1736426010,
7+
"owner": "cachix",
8+
"repo": "devenv",
9+
"rev": "1c384bc4be3ee571511fbbc6fdc94fe47d60f6cf",
10+
"type": "github"
11+
},
12+
"original": {
13+
"dir": "src/modules",
14+
"owner": "cachix",
15+
"repo": "devenv",
16+
"type": "github"
17+
}
18+
},
19+
"flake-compat": {
20+
"flake": false,
21+
"locked": {
22+
"lastModified": 1733328505,
23+
"owner": "edolstra",
24+
"repo": "flake-compat",
25+
"rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
26+
"type": "github"
27+
},
28+
"original": {
29+
"owner": "edolstra",
30+
"repo": "flake-compat",
31+
"type": "github"
32+
}
33+
},
34+
"gitignore": {
35+
"inputs": {
36+
"nixpkgs": [
37+
"pre-commit-hooks",
38+
"nixpkgs"
39+
]
40+
},
41+
"locked": {
42+
"lastModified": 1709087332,
43+
"owner": "hercules-ci",
44+
"repo": "gitignore.nix",
45+
"rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
46+
"type": "github"
47+
},
48+
"original": {
49+
"owner": "hercules-ci",
50+
"repo": "gitignore.nix",
51+
"type": "github"
52+
}
53+
},
54+
"nixpkgs": {
55+
"locked": {
56+
"lastModified": 1733477122,
57+
"owner": "cachix",
58+
"repo": "devenv-nixpkgs",
59+
"rev": "7bd9e84d0452f6d2e63b6e6da29fe73fac951857",
60+
"type": "github"
61+
},
62+
"original": {
63+
"owner": "cachix",
64+
"ref": "rolling",
65+
"repo": "devenv-nixpkgs",
66+
"type": "github"
67+
}
68+
},
69+
"pre-commit-hooks": {
70+
"inputs": {
71+
"flake-compat": "flake-compat",
72+
"gitignore": "gitignore",
73+
"nixpkgs": [
74+
"nixpkgs"
75+
]
76+
},
77+
"locked": {
78+
"lastModified": 1735882644,
79+
"owner": "cachix",
80+
"repo": "pre-commit-hooks.nix",
81+
"rev": "a5a961387e75ae44cc20f0a57ae463da5e959656",
82+
"type": "github"
83+
},
84+
"original": {
85+
"owner": "cachix",
86+
"repo": "pre-commit-hooks.nix",
87+
"type": "github"
88+
}
89+
},
90+
"root": {
91+
"inputs": {
92+
"devenv": "devenv",
93+
"nixpkgs": "nixpkgs",
94+
"pre-commit-hooks": "pre-commit-hooks"
95+
}
96+
}
97+
},
98+
"root": "root",
99+
"version": 7
100+
}

‎docs/devenv.nix

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{ pkgs, lib, inputs, ... }:
2+
3+
# top-level devenv.nix. contains services not essential to running the backend, such as Prometheus and Kafka
4+
{
5+
devcontainer.enable = true;
6+
7+
# https://devenv.sh/common-patterns/#configure-the-shell-based-on-the-current-machine
8+
packages = [
9+
pkgs.gnumake
10+
pkgs.antora
11+
];
12+
13+
# for Antora extensions
14+
languages.javascript.enable = true;
15+
languages.javascript.yarn = {
16+
enable = true;
17+
install.enable = true;
18+
};
19+
}

‎docs/modules/ROOT/nav.adoc

Whitespace-only changes.

‎docs/modules/ROOT/pages/_example.adoc

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
= Welcome!
2+
:navtitle: Welcome
3+
4+
Example using _UML_ and _Emoji_.
5+
6+
emoji:bear[5x]
7+
8+
9+
[plantuml]
10+
----
11+
@startuml
12+
Class01 <|-- Class02
13+
Class03 *-- Class04
14+
Class05 o-- Class06
15+
Class07 .. Class08
16+
Class09 -- Class10
17+
@enduml
18+
----
19+
20+
[source, js]
21+
----
22+
// File: app.js
23+
const User = ({
24+
username:'clsource'
25+
});
26+
----
27+
28+
[dbml]
29+
----
30+
Table users {
31+
id integer
32+
username varchar
33+
role varchar
34+
created_at timestamp
35+
}
36+
37+
Table posts {
38+
id integer [primary key]
39+
title varchar
40+
body text [note: 'Content of the post']
41+
user_id integer
42+
status post_status
43+
created_at timestamp
44+
}
45+
46+
Enum post_status {
47+
draft
48+
published
49+
private [note: 'visible via URL only']
50+
}
51+
52+
Ref: posts.user_id > users.id // many-to-one
53+
----
54+
55+
56+
== Antora Demo Site and Playbook Project
57+
:url-project: https://antora.org
58+
:url-org: https://gitlab.com/antora
59+
:url-group: {url-org}/demo
60+
:url-repo: {url-group}/docs-site
61+
:url-demo-playbook: {url-repo}/blob/main/antora-playbook.yml
62+
:url-antora-docs: https://docs.antora.org/antora/latest
63+
:url-docs-quickstart: {url-antora-docs}/install-and-run-quickstart/
64+
:url-docs-playbook: {url-antora-docs}/playbook/
65+
:url-docs-run: {url-antora-docs}/run-antora/
66+
:url-opendevise: https://opendevise.com
67+
68+
This is the playbook project for the Antora demo site.
69+
You can view the site produced by the Antora playbook ([.path]_antora-playbook.yml_) stored in this project at https://antora.gitlab.io/demo/docs-site.
70+
71+
You can also use this project and the demo documentation components to generate the demo site on your own computer
72+
To use the demo materials and generate the demo site locally, follow the steps in the {url-docs-quickstart}[Antora quickstart].
73+
74+
== Antora Playbook
75+
76+
An {url-docs-playbook}[Antora playbook] is responsible for generating a documentation site.
77+
It contains the instructions a user wants to relay to the Antora site generator.
78+
These instructions include the content Antora should collect and the UI it should apply to the generated site.
79+
80+
The file [.path]_antora-playbook.yml_ in this repository is the playbook used to produce the demo site.
81+
It tells Antora where to find the Component A and Component B remote content repositories and default UI.
82+
83+
== Generate the Demo Site
84+
85+
After cloning this playbook project repository to your computer or setting up your own playbook for the demo site (see the {url-docs-quickstart}[Antora quickstart] for instructions) you can generate the demo site by {url-docs-run}[running Antora].
86+
87+
== Copyright and License
88+
89+
Copyright (C) 2017-present by OpenDevise Inc. and the individual contributors to Antora.
90+
91+
Use of this software is granted under the terms of the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License Version 2.0] (MPL-2.0).
92+
See link:LICENSE[] to find the full license text.
93+
94+
== Authors
95+
96+
Development of Antora is led and sponsored by {url-opendevise}[OpenDevise Inc].

‎docs/modules/ROOT/pages/index.adoc

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
= 🔭 Tololo E-commerce
2+
3+
High in the mountains of the Coquimbo region of Chile lies a peak called
4+
Cerro Tololo, whose name means "`on the edge of the abyss,`" a
5+
description given to the mountain by the ancient Diaguita people, in
6+
reference to its rugged geography on its northeastern side.
7+
8+
- https://en.wikipedia.org/wiki/Cerro_Tololo_Inter-American_Observatory[Wikipedia]
9+
10+
image::https://github.com/user-attachments/assets/e0908d44-0905-4240-b5ab-52e844ad7e6d[By CTIO/NOIRLab/NSF/AURA/R. Sparks - https://noirlab.edu/public/images/iotw2103a/, CC BY 4.0, https://commons.wikimedia.org/w/index.php?curid=99545008]
11+
12+
*Tololo* is a set of _Elixir_ components that bring functionality akin
13+
to Shopify and other e-commerce platforms to
14+
https://phoenixframework.org/[Phoenix Framework]. You have complete
15+
freedom to create your own storefront(s), but we’ve already done the
16+
hard work for you in the backend.
17+
18+
[CAUTION]
19+
====
20+
Version 1.x is currently in alpha release. We recommend this
21+
version for new projects, however, it is not feature-complete and
22+
therefore may not be deemed production-ready.
23+
====
24+
25+
[IMPORTANT]
26+
====
27+
Tololo is mainly targeted to Chilean’s market needs.
28+
====
29+
30+
== Features
31+
32+
Tololo E-commerce is mainly inspired by
33+
https://github.com/lunarphp/lunar[Lunar PHP] and https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api[Shopify Storefront API] and aims to be similar in scope and features.
34+
35+
- *Ecommerce Engine*: Based around https://ash-hq.org/[Ash Framework]
36+
models, the e-commerce core provides all the functionality you need to
37+
create an online store.
38+
39+
- *Backoffice*: Manage your catalogue, customers and orders in our
40+
modern and extendable admin area, built in _Phoenix LiveView_.
41+
42+
- *API*: Power your storefront or mobile app via _Tololo’s_ API.
43+
44+
== Learning
45+
46+
This project is not only a product that can be used in the Real World™,
47+
but is meant to be used as an example to learn how to make an
48+
professional _Elixir_ artifact. So we take great care in documentation
49+
for developers.

‎docs/modules/decisions/nav.adoc

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.Architecture Decisions
2+
* xref:0000-use-adr.adoc[]
3+
* xref:use-elixir-phoenix.adoc[]
4+
* xref:use-ash.adoc[]
5+
* xref:use-nix.adoc[]
6+
* xref:use-antora-docs.adoc[]
7+
* xref:use-tbd-and-cc.adoc[]

0 commit comments

Comments
 (0)