From f81a7f42d8f10467108bab784117a380e0070ece Mon Sep 17 00:00:00 2001 From: Jan-Simon Moeller Date: Thu, 14 Jan 2021 18:18:25 +0100 Subject: [PATCH] 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 Change-Id: Id1f9812d0f4db83cb72bf03987dc95d754e00725 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25913 --- .gitignore | 1 + docs/5_Component_Documentation/0_AGL_components.md | 14 ++++++++++++++ docs/5_Component_Documentation/1_agl-compositor.md | 7 +++++++ .../2_waltham-receiver_waltham-transmitter.md | 7 +++++++ docs/5_Component_Documentation/3_rba.md | 7 +++++++ docs/5_Component_Documentation/4_drm-leasemanager.md | 7 +++++++ docs/5_Component_Documentation/5_appfw.md | 7 +++++++ docs/5_Component_Documentation/6_cynagora.md | 7 +++++++ docs/5_Component_Documentation/7_pyagl.md | 7 +++++++ docs/5_Component_Documentation/8_pipewire_wireplumber.md | 7 +++++++ .../1_Getting_Linux_Foundation_account.md | 0 .../2_Using_Jira_for_current_work_items.md | 0 .../3_Working_with_Gerrit.md | 0 .../4_Submitting_Changes.md | 0 .../5_Reviewing_Changes.md | 0 .../6_Gerrit_Recommended_Practices.md | 0 .../7_General_Guidelines.md | 0 .../8_Adding_Documentation.md | 0 .../9_Contribution_Checklist.md | 0 .../images/jira-1.png | Bin .../images/jira-2.png | Bin .../images/jira-3.png | Bin .../images/review.png | Bin 23 files changed, 71 insertions(+) create mode 100644 .gitignore create mode 100644 docs/5_Component_Documentation/0_AGL_components.md create mode 100644 docs/5_Component_Documentation/1_agl-compositor.md create mode 100644 docs/5_Component_Documentation/2_waltham-receiver_waltham-transmitter.md create mode 100644 docs/5_Component_Documentation/3_rba.md create mode 100644 docs/5_Component_Documentation/4_drm-leasemanager.md create mode 100644 docs/5_Component_Documentation/5_appfw.md create mode 100644 docs/5_Component_Documentation/6_cynagora.md create mode 100644 docs/5_Component_Documentation/7_pyagl.md create mode 100644 docs/5_Component_Documentation/8_pipewire_wireplumber.md rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/1_Getting_Linux_Foundation_account.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/2_Using_Jira_for_current_work_items.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/3_Working_with_Gerrit.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/4_Submitting_Changes.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/5_Reviewing_Changes.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/6_Gerrit_Recommended_Practices.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/7_General_Guidelines.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/8_Adding_Documentation.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/9_Contribution_Checklist.md (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/images/jira-1.png (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/images/jira-2.png (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/images/jira-3.png (100%) rename docs/{5_How_To_Contribute => 6_How_To_Contribute}/images/review.png (100%) 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 similarity index 100% rename from docs/5_How_To_Contribute/1_Getting_Linux_Foundation_account.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/2_Using_Jira_for_current_work_items.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/3_Working_with_Gerrit.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/4_Submitting_Changes.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/5_Reviewing_Changes.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/6_Gerrit_Recommended_Practices.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/7_General_Guidelines.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/8_Adding_Documentation.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/9_Contribution_Checklist.md rename to 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 similarity index 100% rename from docs/5_How_To_Contribute/images/jira-1.png rename to docs/6_How_To_Contribute/images/jira-1.png diff --git a/docs/5_How_To_Contribute/images/jira-2.png b/docs/6_How_To_Contribute/images/jira-2.png similarity index 100% rename from docs/5_How_To_Contribute/images/jira-2.png rename to docs/6_How_To_Contribute/images/jira-2.png diff --git a/docs/5_How_To_Contribute/images/jira-3.png b/docs/6_How_To_Contribute/images/jira-3.png similarity index 100% rename from docs/5_How_To_Contribute/images/jira-3.png rename to docs/6_How_To_Contribute/images/jira-3.png diff --git a/docs/5_How_To_Contribute/images/review.png b/docs/6_How_To_Contribute/images/review.png similarity index 100% rename from docs/5_How_To_Contribute/images/review.png rename to docs/6_How_To_Contribute/images/review.png -- 2.16.6