summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJan-Simon Moeller <jsmoeller@linuxfoundation.org>2021-01-14 18:18:25 +0100
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2021-01-20 23:52:26 +0000
commitf81a7f42d8f10467108bab784117a380e0070ece (patch)
tree28f7c7a31cc279f176508cc4eb0f9dc3b3e2acbe
parent48873cd821ac1cd50bf33a737a898f4c58702a62 (diff)
Add a category for agl-compositor and rba documentation
Create a home for docs of compositor, rba and pipewire/wireplumber. Also add a .gitignore file. Signed-off-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Change-Id: Id1f9812d0f4db83cb72bf03987dc95d754e00725 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25913
-rw-r--r--.gitignore1
-rw-r--r--docs/5_Component_Documentation/0_AGL_components.md14
-rw-r--r--docs/5_Component_Documentation/1_agl-compositor.md7
-rw-r--r--docs/5_Component_Documentation/2_waltham-receiver_waltham-transmitter.md7
-rw-r--r--docs/5_Component_Documentation/3_rba.md7
-rw-r--r--docs/5_Component_Documentation/4_drm-leasemanager.md7
-rw-r--r--docs/5_Component_Documentation/5_appfw.md7
-rw-r--r--docs/5_Component_Documentation/6_cynagora.md7
-rw-r--r--docs/5_Component_Documentation/7_pyagl.md7
-rw-r--r--docs/5_Component_Documentation/8_pipewire_wireplumber.md7
-rw-r--r--docs/6_How_To_Contribute/1_Getting_Linux_Foundation_account.md (renamed from docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md)0
-rw-r--r--docs/6_How_To_Contribute/2_Using_Jira_for_current_work_items.md (renamed from docs/5_How_To_Contribute/2_Using_Jira_for_current_work_items.md)0
-rw-r--r--docs/6_How_To_Contribute/3_Working_with_Gerrit.md (renamed from docs/5_How_To_Contribute/3_Working_with_Gerrit.md)0
-rw-r--r--docs/6_How_To_Contribute/4_Submitting_Changes.md (renamed from docs/5_How_To_Contribute/4_Submitting_Changes.md)0
-rw-r--r--docs/6_How_To_Contribute/5_Reviewing_Changes.md (renamed from docs/5_How_To_Contribute/5_Reviewing_Changes.md)0
-rw-r--r--docs/6_How_To_Contribute/6_Gerrit_Recommended_Practices.md (renamed from docs/5_How_To_Contribute/6_Gerrit_Recommended_Practices.md)0
-rw-r--r--docs/6_How_To_Contribute/7_General_Guidelines.md (renamed from docs/5_How_To_Contribute/7_General_Guidelines.md)0
-rw-r--r--docs/6_How_To_Contribute/8_Adding_Documentation.md (renamed from docs/5_How_To_Contribute/8_Adding_Documentation.md)0
-rw-r--r--docs/6_How_To_Contribute/9_Contribution_Checklist.md (renamed from docs/5_How_To_Contribute/9_Contribution_Checklist.md)0
-rw-r--r--docs/6_How_To_Contribute/images/jira-1.png (renamed from docs/5_How_To_Contribute/images/jira-1.png)bin14224 -> 14224 bytes
-rw-r--r--docs/6_How_To_Contribute/images/jira-2.png (renamed from docs/5_How_To_Contribute/images/jira-2.png)bin74302 -> 74302 bytes
-rw-r--r--docs/6_How_To_Contribute/images/jira-3.png (renamed from docs/5_How_To_Contribute/images/jira-3.png)bin61399 -> 61399 bytes
-rw-r--r--docs/6_How_To_Contribute/images/review.png (renamed from docs/5_How_To_Contribute/images/review.png)bin56853 -> 56853 bytes
23 files changed, 71 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ccbfadb
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+site/ \ No newline at end of file
diff --git a/docs/5_Component_Documentation/0_AGL_components.md b/docs/5_Component_Documentation/0_AGL_components.md
new file mode 100644
index 0000000..d1f5d83
--- /dev/null
+++ b/docs/5_Component_Documentation/0_AGL_components.md
@@ -0,0 +1,14 @@
+---
+title: AGL Components
+---
+
+# Components under development within AGL
+
+- agl-compositor.md
+- waltham-receiver_waltham-transmitter.md
+- rba.md
+- drm-leasemanager.md
+- appfw.md
+- cynagora.md
+- pyagl.md
+- pipewire_wireplumber.md
diff --git a/docs/5_Component_Documentation/1_agl-compositor.md b/docs/5_Component_Documentation/1_agl-compositor.md
new file mode 100644
index 0000000..892a48f
--- /dev/null
+++ b/docs/5_Component_Documentation/1_agl-compositor.md
@@ -0,0 +1,7 @@
+---
+title: agl-compositor
+---
+
+# agl-compositor
+
+FIXME.
diff --git a/docs/5_Component_Documentation/2_waltham-receiver_waltham-transmitter.md b/docs/5_Component_Documentation/2_waltham-receiver_waltham-transmitter.md
new file mode 100644
index 0000000..cfaaf7b
--- /dev/null
+++ b/docs/5_Component_Documentation/2_waltham-receiver_waltham-transmitter.md
@@ -0,0 +1,7 @@
+---
+title: Waltham receiver/transmitter
+---
+
+# waltham
+
+FIXME.
diff --git a/docs/5_Component_Documentation/3_rba.md b/docs/5_Component_Documentation/3_rba.md
new file mode 100644
index 0000000..340d4b1
--- /dev/null
+++ b/docs/5_Component_Documentation/3_rba.md
@@ -0,0 +1,7 @@
+---
+title: Rule Based Arbitrator (rba)
+---
+
+# rba
+
+FIXME.
diff --git a/docs/5_Component_Documentation/4_drm-leasemanager.md b/docs/5_Component_Documentation/4_drm-leasemanager.md
new file mode 100644
index 0000000..30f86cc
--- /dev/null
+++ b/docs/5_Component_Documentation/4_drm-leasemanager.md
@@ -0,0 +1,7 @@
+---
+title: DRM lease manager
+---
+
+# DRM lease manager
+
+FIXME.
diff --git a/docs/5_Component_Documentation/5_appfw.md b/docs/5_Component_Documentation/5_appfw.md
new file mode 100644
index 0000000..1af8796
--- /dev/null
+++ b/docs/5_Component_Documentation/5_appfw.md
@@ -0,0 +1,7 @@
+---
+title: Application Framework
+---
+
+# AppFW
+
+FIXME.
diff --git a/docs/5_Component_Documentation/6_cynagora.md b/docs/5_Component_Documentation/6_cynagora.md
new file mode 100644
index 0000000..d2c74ce
--- /dev/null
+++ b/docs/5_Component_Documentation/6_cynagora.md
@@ -0,0 +1,7 @@
+---
+title: Cynagora
+---
+
+# cynagora
+
+FIXME.
diff --git a/docs/5_Component_Documentation/7_pyagl.md b/docs/5_Component_Documentation/7_pyagl.md
new file mode 100644
index 0000000..6de0a07
--- /dev/null
+++ b/docs/5_Component_Documentation/7_pyagl.md
@@ -0,0 +1,7 @@
+---
+title: PyAGL
+---
+
+# PyAGL
+
+FIXME.
diff --git a/docs/5_Component_Documentation/8_pipewire_wireplumber.md b/docs/5_Component_Documentation/8_pipewire_wireplumber.md
new file mode 100644
index 0000000..d5ca335
--- /dev/null
+++ b/docs/5_Component_Documentation/8_pipewire_wireplumber.md
@@ -0,0 +1,7 @@
+---
+title: Pipewire / Wireplumber
+---
+
+# Pipewire / Wireplumber
+
+FIXME.
diff --git a/docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md b/docs/6_How_To_Contribute/1_Getting_Linux_Foundation_account.md
index c4d8b08..c4d8b08 100644
--- a/docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md
+++ b/docs/6_How_To_Contribute/1_Getting_Linux_Foundation_account.md
diff --git a/docs/5_How_To_Contribute/2_Using_Jira_for_current_work_items.md b/docs/6_How_To_Contribute/2_Using_Jira_for_current_work_items.md
index 49b443d..49b443d 100644
--- a/docs/5_How_To_Contribute/2_Using_Jira_for_current_work_items.md
+++ b/docs/6_How_To_Contribute/2_Using_Jira_for_current_work_items.md
diff --git a/docs/5_How_To_Contribute/3_Working_with_Gerrit.md b/docs/6_How_To_Contribute/3_Working_with_Gerrit.md
index 44da2d9..44da2d9 100644
--- a/docs/5_How_To_Contribute/3_Working_with_Gerrit.md
+++ b/docs/6_How_To_Contribute/3_Working_with_Gerrit.md
diff --git a/docs/5_How_To_Contribute/4_Submitting_Changes.md b/docs/6_How_To_Contribute/4_Submitting_Changes.md
index d226450..d226450 100644
--- a/docs/5_How_To_Contribute/4_Submitting_Changes.md
+++ b/docs/6_How_To_Contribute/4_Submitting_Changes.md
diff --git a/docs/5_How_To_Contribute/5_Reviewing_Changes.md b/docs/6_How_To_Contribute/5_Reviewing_Changes.md
index e9d6758..e9d6758 100644
--- a/docs/5_How_To_Contribute/5_Reviewing_Changes.md
+++ b/docs/6_How_To_Contribute/5_Reviewing_Changes.md
diff --git a/docs/5_How_To_Contribute/6_Gerrit_Recommended_Practices.md b/docs/6_How_To_Contribute/6_Gerrit_Recommended_Practices.md
index 671c685..671c685 100644
--- a/docs/5_How_To_Contribute/6_Gerrit_Recommended_Practices.md
+++ b/docs/6_How_To_Contribute/6_Gerrit_Recommended_Practices.md
diff --git a/docs/5_How_To_Contribute/7_General_Guidelines.md b/docs/6_How_To_Contribute/7_General_Guidelines.md
index b72e912..b72e912 100644
--- a/docs/5_How_To_Contribute/7_General_Guidelines.md
+++ b/docs/6_How_To_Contribute/7_General_Guidelines.md
diff --git a/docs/5_How_To_Contribute/8_Adding_Documentation.md b/docs/6_How_To_Contribute/8_Adding_Documentation.md
index d2aad82..d2aad82 100644
--- a/docs/5_How_To_Contribute/8_Adding_Documentation.md
+++ b/docs/6_How_To_Contribute/8_Adding_Documentation.md
diff --git a/docs/5_How_To_Contribute/9_Contribution_Checklist.md b/docs/6_How_To_Contribute/9_Contribution_Checklist.md
index 7d86ada..7d86ada 100644
--- a/docs/5_How_To_Contribute/9_Contribution_Checklist.md
+++ b/docs/6_How_To_Contribute/9_Contribution_Checklist.md
diff --git a/docs/5_How_To_Contribute/images/jira-1.png b/docs/6_How_To_Contribute/images/jira-1.png
index 4a39bfb..4a39bfb 100644
--- a/docs/5_How_To_Contribute/images/jira-1.png
+++ b/docs/6_How_To_Contribute/images/jira-1.png
Binary files differ
diff --git a/docs/5_How_To_Contribute/images/jira-2.png b/docs/6_How_To_Contribute/images/jira-2.png
index c1cdb21..c1cdb21 100644
--- a/docs/5_How_To_Contribute/images/jira-2.png
+++ b/docs/6_How_To_Contribute/images/jira-2.png
Binary files differ
diff --git a/docs/5_How_To_Contribute/images/jira-3.png b/docs/6_How_To_Contribute/images/jira-3.png
index b1bec2e..b1bec2e 100644
--- a/docs/5_How_To_Contribute/images/jira-3.png
+++ b/docs/6_How_To_Contribute/images/jira-3.png
Binary files differ
diff --git a/docs/5_How_To_Contribute/images/review.png b/docs/6_How_To_Contribute/images/review.png
index 805166a..805166a 100644
--- a/docs/5_How_To_Contribute/images/review.png
+++ b/docs/6_How_To_Contribute/images/review.png
Binary files differ