#93 Migrate default git branch from master to main (closes #86)
Merged 4 years ago by bcotton. Opened 4 years ago by jflory7.
Fedora-Council/ jflory7/council-docs change/default-git-branch  into  master

file modified
+3 -3
@@ -1,11 +1,11 @@ 

  # Name will be mostly visible in the URL. Treat it as an indentifier.

  # 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: council

- # Title will be visible on the page. 

+ # Title will be visible on the page.

  title: Fedora Council

  # 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. 

+ version: main

+ # 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:

@@ -321,7 +321,7 @@ 

  as of Nov. 26th, 2014. Any other significant changes will be noted here;

  smaller changes (minor wording or formating, etc., without impact on

  meaning) can be found in the

- https://pagure.io/Fedora-Council/council-docs/commits/master[git repository]

+ https://pagure.io/Fedora-Council/council-docs/commits/main[git repository]

  for Council documents.

  

  2017-11-15: Update Diversity Advisor to Diversity Team Representative

@@ -16,7 +16,7 @@ 

  

  == Content

  

- Teams should list the following information in the format specified by https://pagure.io/Fedora-Council/council-docs/blob/master/f/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc[the template]:

+ Teams should list the following information in the format specified by https://pagure.io/Fedora-Council/council-docs/blob/main/f/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc[the template]:

  

  * Team name

  * Team summary
@@ -51,7 +51,7 @@ 

  The directory requires a file that contains the information about the team.

  The suggested naming convention is `NAME_team_info.adoc`, but any valid file name is acceptable.

  The file may be stored in the team's own documentation repository or in the https://pagure.io/Fedora-Council/council-docs/[council-docs repository].

- See the https://pagure.io/Fedora-Council/council-docs/blob/master/f/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc[example template] for format and structure.

+ See the https://pagure.io/Fedora-Council/council-docs/blob/main/f/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc[example template] for format and structure.

  

  === Rendering the directory

  
@@ -60,5 +60,5 @@ 

  

  === Reusing the data on team pages

  

- Teams can include their `NAME_team_info.adoc` file on their page(s), and then use `{team_name}`, `{team_summary}` etc. anywhere on the page. 

+ Teams can include their `NAME_team_info.adoc` file on their page(s), and then use `{team_name}`, `{team_summary}` etc. anywhere on the page.

  

file modified
+4 -4
@@ -2,13 +2,13 @@ 

  # 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: engineering  # <---- PLEASE MODIFY

  

- # Title will be visible on the page. 

+ # Title will be visible on the page.

  title: Engineering Teams # <---- PLEASE MODIFY

  

- # 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

+ # 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 "main" to a specific version.

+ version: main

  

- # 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.

file modified
+4 -4
@@ -2,13 +2,13 @@ 

  # 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: mindshare  # <---- PLEASE MODIFY

  

- # Title will be visible on the page. 

+ # Title will be visible on the page.

  title: Mindshare Teams # <---- PLEASE MODIFY

  

- # 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

+ # 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 "main" to a specific version.

+ version: main

  

- # 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.

file modified
+4 -4
@@ -2,13 +2,13 @@ 

  # 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: project

  

- # Title will be visible on the page. 

+ # Title will be visible on the page.

  title: Fedora Project

  

- # 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

+ # 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 "main" to a specific version.

+ version: main

  

- # 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.

Last month, GitHub switched their default git branch from master to
main. So, if GitHub is doing it for their millions and millions of
repos and users, there are few good reasons not to for this repo.

https://github.com/github/renaming

This commit changes all references of master to main in the Antora
site configuration. This commit is already pushed to a git branch,
main, on the council-docs repo. But this commit will be opened as a
Pull Request to the master branch.

Do not merge without coordinating on the fedora-docs/docs-fp-o PR.
If the builder is still configured to build onto master, well, that
obviously will not work. Please coordinate these changes simultaneously.

Closes #86. cc: @mattdm

P.S. — This Pull Request was brought to you by incantations of grep and sed. Coreutils ftw…

docs-fp-o PR is 151

LGTM. I have commit on both repos, so I can coordinate the merges. I'll do it on Monday to give people time to provide additional feedback.

rebased onto c9543d0

4 years ago

Metadata Update from @jflory7:
- Request assigned

4 years ago

Pull-Request has been merged by bcotton

4 years ago