PR#238: modules: Remove Join SIG pages and put redirects in their place - fedora-commops

fedora-commops

#238 modules: Remove Join SIG pages and put redirects in their place

Merged 2 years ago by jflory7. Opened 2 years ago by jflory7.

remove/join-redirects into main

modules: Remove Join SIG pages and put redirects in their place

Justin W. Flory (he/him) [Fedora Project] • 2 years ago

d5bc923

docs/antora.yml

file modified

+5 -3

		`@@ -2,15 +2,17 @@`
		`# Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page)`
		`name: commops`

		`- # Title will be visible on the page.`
		`+ # Title will be visible on the page.`
		`title: CommOps`

		`# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version.`
		`version: master`

		`- # We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.`
		`+ # We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.`
		`start_page: ROOT:index`

		`# This lists all the menu definitions of your component.`
		`nav:`
		`- - modules/ROOT/nav.adoc`
		`+ - modules/ROOT/nav.adoc`
		`+ - modules/teams/nav.adoc`
		`+ - modules/handbooks/nav.adoc`

docs/modules/handbooks/nav.adoc

file added

		`@@ -0,0 +1,2 @@`
		`+ * Role Handbooks`
		`+ ** xref:fedora-join::welcome/welcome.adoc[Join SIG Team Member]`

docs/modules/handbooks/pages/join-sig-member.adoc

file removed

-3

		`@@ -1,3 +0,0 @@`
		`- include::ROOT:partial$attributes.adoc[]`
		`-`
		`- = Fedora Join SIG Team Member`

docs/modules/teams/nav.adoc

file added

		`@@ -0,0 +1,2 @@`
		`+ * Team Overviews`
		`+ ** xref:fedora-join::index.adoc[Join SIG]`

docs/modules/teams/pages/join-sig.adoc

file removed

-3

		`@@ -1,3 +0,0 @@`
		`- include::ROOT:partial$attributes.adoc[]`
		`-`
		`- = Fedora Join Special Interest Group (SIG)`

jflory7 commented 2 years ago

This commit removes the Join SIG placeholder pages here, and instead
links out to the existing Fedora Join SIG documentation. This saves us
time and effort of duplicating content that already exists, and it also
makes it more visible alongside the other content that remains to be
written (e.g. team overview and role handbook pages).

jflory7 commented 2 years ago

Corresponding Pull Request: https://pagure.io/fedora-join/fedora-join-docs/pull-request/10

Metadata Update from @jflory7:
- Pull-request tagged with: type - docs

2 years ago

jflory7 commented 2 years ago

I am going to pre-emptively merge this Pull Request without a review. There is a part of this that (unfortunately) will only be tested in production. I'm going for a "fail early, fail often" approach by merging it, in the hope if it is a bad change, it can be corrected quickly while these docs are getting a lot of focus.

Metadata Update from @jflory7:
- Request assigned

2 years ago

Pull-Request has been merged by jflory7

2 years ago