From bf5351abcd0cc484f3c096b0aff63f147fa2307b Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Mar 02 2018 16:47:34 +0000 Subject: [PATCH 1/4] add references --- diff --git a/en-US/References.adoc b/en-US/References.adoc index 1a4d983..25af978 100644 --- a/en-US/References.adoc +++ b/en-US/References.adoc @@ -1,7 +1,14 @@ = References -== modulemd specification +https://pagure.io/modulemd[Module metadata definitions (modulemd)]:: + A modulemd file is used to define a module, and also to provide metadata for the end result. This is a specification of the file. + We are currently on version 1 of the specification with version 2 due very soon. -The format of the module definition, referred to as a "modulemd" or "module yaml," is specified by the https://pagure.io/modulemd[modulemd Pagure repository]. -See link:Making_Modules.html#overview-of-module-files[Making Modules] for more details on how to name this file. -We are currently on version 1 of the specification with version 2 due very soon. \ No newline at end of file +https://pagure.io/modularity/issues[General issue tracker for Modularity]:: + General issues that are tracked here. + +https://pagure.io/group/modularity[Modularity on Pagure]:: + Pagure is the default place for most of our git repositories. + +https://github.com/fedora-modularity/[Modularity on GitHub]:: + GitHub is an alternative place for some of our repositories. From 22c518b3372d63d3154c4c79087289afc29def61 Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Mar 02 2018 16:47:34 +0000 Subject: [PATCH 2/4] rename Contributors to Community --- diff --git a/_topic_map.yml b/_topic_map.yml index 27a7f25..b25fd29 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -42,8 +42,8 @@ Topics: File: Building_Software - Name: Consuming Software File: Consuming_Software - - Name: For Modularity Contributors - Dir: contributors + - Name: Community + Dir: community Topics: - Name: Communication File: Communication diff --git a/en-US/community/Communication.adoc b/en-US/community/Communication.adoc new file mode 100644 index 0000000..7d475db --- /dev/null +++ b/en-US/community/Communication.adoc @@ -0,0 +1,31 @@ += Communication + +This page lists the communication channels and meetings of members of the Modularity Working Group (Modularity WG). + + +== Channels + +There are two main communication channels the Modularity WG uses: + +:hash: # + +https://webchat.freenode.net/?channels=fedora-modularity[{hash}fedora-modularity] on freenode:: +Most of the discussions happen on this IRC channel. + +https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/[devel@lists.fedoraproject.org]:: +The Modularity WG doesn't have a dedicated mailng list. +Instead, the Fedora Devel mailing list is used time to time for more complex decisions or announcements. + +https://lists.fedoraproject.org/archives/list/server@lists.fedoraproject.org/[server@lists.fedoraproject.org]:: +The https://fedoraproject.org/wiki/Server[Server SIG] also discusses Modularity at times as the Server Edition is a primary stakeholder in the goals of the https://fedoraproject.org/wiki/Objectives#Current[Modularity Objective]. + +== Meetings + +Meetings are listed on the https://apps.fedoraproject.org/calendar/modularity/[Modularity calendar]. +Currently, there are two alternating meetings on Tuesday: + +Modularity WG:: +A formal meeting of the Modularity WG to discuss, post updates, and make dedisions. + +Office Hours:: +No formal agenda, members of the Modularity WG promise to be present at this time for questions or discussion. diff --git a/en-US/contributors/Communication.adoc b/en-US/contributors/Communication.adoc deleted file mode 100644 index 7d475db..0000000 --- a/en-US/contributors/Communication.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Communication - -This page lists the communication channels and meetings of members of the Modularity Working Group (Modularity WG). - - -== Channels - -There are two main communication channels the Modularity WG uses: - -:hash: # - -https://webchat.freenode.net/?channels=fedora-modularity[{hash}fedora-modularity] on freenode:: -Most of the discussions happen on this IRC channel. - -https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/[devel@lists.fedoraproject.org]:: -The Modularity WG doesn't have a dedicated mailng list. -Instead, the Fedora Devel mailing list is used time to time for more complex decisions or announcements. - -https://lists.fedoraproject.org/archives/list/server@lists.fedoraproject.org/[server@lists.fedoraproject.org]:: -The https://fedoraproject.org/wiki/Server[Server SIG] also discusses Modularity at times as the Server Edition is a primary stakeholder in the goals of the https://fedoraproject.org/wiki/Objectives#Current[Modularity Objective]. - -== Meetings - -Meetings are listed on the https://apps.fedoraproject.org/calendar/modularity/[Modularity calendar]. -Currently, there are two alternating meetings on Tuesday: - -Modularity WG:: -A formal meeting of the Modularity WG to discuss, post updates, and make dedisions. - -Office Hours:: -No formal agenda, members of the Modularity WG promise to be present at this time for questions or discussion. From 9fac05002e830fde280b643e389eda3ce4dd6f7b Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Mar 02 2018 16:47:34 +0000 Subject: [PATCH 3/4] add 'under construction' banners to some pages --- diff --git a/en-US/Making_Modules.adoc b/en-US/Making_Modules.adoc index 9361799..b0bf635 100644 --- a/en-US/Making_Modules.adoc +++ b/en-US/Making_Modules.adoc @@ -1,5 +1,7 @@ = Making Modules +NOTE: This page is a placeholder. You can make this page more useful by submitting a pull-request to https://pagure.io/fedora-docs/modularity/ + == Overview of module files explain module.yaml, what it should be named, what the branch should be called, where to find the spec, some example diff --git a/en-US/Using_Modules.adoc b/en-US/Using_Modules.adoc index afb0bc9..4863c2c 100644 --- a/en-US/Using_Modules.adoc +++ b/en-US/Using_Modules.adoc @@ -1,5 +1,7 @@ = Using Modules in Fedora +NOTE: This page is a placeholder. You can make this page more useful by submitting a pull-request to https://pagure.io/fedora-docs/modularity/ + == Enable Modularity on Fedora 28 how do you turn on the modular repo? is it there by default? From 2b899423a209be50ffe5ff9b747c853ea9bc1f50 Mon Sep 17 00:00:00 2001 From: Adam Samalik Date: Mar 02 2018 16:47:34 +0000 Subject: [PATCH 4/4] fix links --- diff --git a/en-US/architecture/Main_Concepts.adoc b/en-US/architecture/Main_Concepts.adoc index 9fc9b43..d861905 100644 --- a/en-US/architecture/Main_Concepts.adoc +++ b/en-US/architecture/Main_Concepts.adoc @@ -55,7 +55,7 @@ This also works the other way round, the same stream for multiple releases. image::mod-doc-stream.png[,80%,] A *stream* is a series of versions having a goal such as backwards API/ABI compatibility or delivering the latest stable version. -A “nodejs” interpreter can have streams such as “https://src.fedoraproject.org/modules/nodejs/branch/6[6]” or “https://src.fedoraproject.org/modules/nodejs/branch/8[8]” (two current versions of nodejs), but also “devel” or “latest”. +A “nodejs” interpreter can have streams such as https://src.fedoraproject.org/modules/nodejs/branch/6[6] or https://src.fedoraproject.org/modules/nodejs/branch/8[8] (two current versions of nodejs), but also “devel” or “latest”. Some packages don’t have a major version. An example could be the “calc” package that is being developed in two branches “stable” and “unstable”.