Skip to content

Commit

Permalink
Updating references from master to main in several docs (#617)
Browse files Browse the repository at this point in the history
* Updating references from master to main

As part of the changes in ticket medic/cht-core#6574, I have updated the references from master to main in several docs. However, not all are changed yet, as some repos still have the old default branch name (master), so it wouldn't be accurate to change them now.

* Updated URL to avoid 301 redirect

Updated URL to avoid 301 redirect.

Target branch is still master as cht-conf does not have a main branch as default yet.

* Update content/en/apps/guides/hosting/ec2-setup-guide.md

Co-authored-by: Gareth Bowen <gareth@medic.org>

* Update content/en/core/releases/3.8.0.md

Co-authored-by: Marc Abbyad <789512+abbyad@users.noreply.github.com>

* Undoing changes to avoid confusion with branch names

As some other repos don't have a main branch yet as their default, I'm rolling back a few changes suggested by @garethbowen

Co-authored-by: Gareth Bowen <gareth@medic.org>
Co-authored-by: Marc Abbyad <789512+abbyad@users.noreply.github.com>
  • Loading branch information
3 people committed Feb 21, 2022
1 parent 5571e2c commit 8577f7e
Show file tree
Hide file tree
Showing 13 changed files with 20 additions and 20 deletions.
4 changes: 2 additions & 2 deletions .github/scripts/muffet.sh
@@ -1,6 +1,6 @@
#!/bin/bash

# This script is used in Github Actions to do link checking on commits to branches and master, so
# This script is used in Github Actions to do link checking on commits to branches and main, so
# please edit with care! See ../workflows/ci.yml for specific usage.
#
# If you're doing local development and want to run link checkers locally, please use this script!
Expand All @@ -26,6 +26,6 @@ muffet http://localhost:1313 \
--exclude "https://github\.com/medic/cht-core/issues/new.*" \
--exclude "https://github\.com/medic/cht-docs/commit.*" \
--exclude "https://github\.com/medic/cht-core/commit.*" \
--exclude "https://github\.com/medic/cht-docs/edit/master/.*" \
--exclude "https://github\.com/medic/cht-docs/edit/main/.*" \
--exclude ".*localhost:5984.*" \
--exclude "https://docs.google.com/spreadsheets/d/12345ABCDEF/edit#gid=555666888"
2 changes: 1 addition & 1 deletion content/en/apps/guides/hosting/ec2-setup-guide.md
Expand Up @@ -59,7 +59,7 @@ This guide will walk you through the process of creating an EC2 instance, mounti
- See [SSL Certficates]({{< relref "apps/guides/hosting/ssl-cert-install">}}) to install new certificates

1. Configure couch2pg
See the [couch2pg basic configuration](https://github.com/medic/medic-couch2pg/blob/master/README.md) in the `medic-couch2pg` repository.
See the [couch2pg basic configuration](https://github.com/medic/cht-couch2pg/blob/main/README.md) in the `cht-couch2pg` repository.

1. Setup postgres to work with couch2pg
- Creating the database, setting up permissions, exploring the tables and what they store
Expand Down
4 changes: 2 additions & 2 deletions content/en/contribute/docs/workflow.md
Expand Up @@ -15,15 +15,15 @@ Anyone can contribute to CHT documentation by opening an issue in the [`cht-docs
* It is helpful to be comfortable with [git]({{< ref "core/guides/using-git" >}}) and [GitHub](https://lab.github.com/) to contribute to the CHT community.
* The documentation source is in [GitHub](https://github.com/medic/cht-docs). The content pages are in the `/content/en/` directory.
* Documentation is written in [Markdown](https://www.markdownguide.org/).
* The CHT site build uses [Hugo](https://gohugo.io/). You can also setup a [local clone](https://github.com/medic/cht-docs/blob/master/README.md).
* The CHT site build uses [Hugo](https://gohugo.io/). You can also setup a [local clone](https://github.com/medic/cht-docs/blob/main/README.md).

## Writing Documentation

A high degree of importance is put on consistency and usability of CHT documentation so that it is accessible and understood by a wide audience. The CHT [documentation style guide]({{< ref "contribute/docs/style-guide" >}}) will help to write documentation in the most consistent and useful way.

## Commits to GitHub

The main branch is `master` which must be kept stable since it is deployed to the doc site. All documentation changes should be done in a branch with a Pull Request when ready for review. This means that a maintainer has signed off on the change before it hits the master branch.
The main branch is `main` which must be kept stable since it is deployed to the doc site. All documentation changes should be done in a branch with a Pull Request when ready for review. This means that a maintainer has signed off on the change before it hits the main branch.

Format your commit messages according to the Git convention where the first line should be a short title/summary (50 characters or so) with more details in a separate paragraph (if needed).

Expand Down
2 changes: 1 addition & 1 deletion content/en/core/guides/update-dependencies.md
Expand Up @@ -19,7 +19,7 @@ Every minor release we update dependencies to get the latest fixes and improveme

## Steps

1. `git checkout master && git pull` - get the latest code
1. Checkout and pull the latest default branch - get the latest code
2. `git checkout -b "<issue>-update-dendencies"` - make a branch

Then for each folder go through these steps.
Expand Down
10 changes: 5 additions & 5 deletions content/en/core/guides/using-git.md
Expand Up @@ -74,12 +74,12 @@ for i in `cat files`; do \
done | sort | uniq > all-files
```

In the following commands I assume the branch we are working on is `master`, but this could easily be applied to any branch.
In the following commands I assume the branch we are working on is `main`, but this could easily be applied to any branch.

Take a note of your original commit count.

```
$ git rev-list master | wc -l
$ git rev-list main | wc -l
6844
```

Expand Down Expand Up @@ -115,7 +115,7 @@ git filter-branch -f --prune-empty --index-filter '\
Nice, less commits!

```
$ git rev-list master | wc -l
$ git rev-list main | wc -l
461
```

Expand Down Expand Up @@ -183,7 +183,7 @@ Look Ma, I'm all cleaned up!

```
$ git for-each-ref
dbcc2677aa56c40fbf83d72e6e413b86d3b2be79 commit refs/heads/master
dbcc2677aa56c40fbf83d72e6e413b86d3b2be79 commit refs/heads/main
$ git rev-list --all | wc -l
461
$ du -hs .git
Expand All @@ -194,7 +194,7 @@ Maybe have a play now and make sure things look right to you. Then publish your

```
$ git remote add origin git@github.com:medic/medic-smsparser.git
$ git push origin master
$ git push origin main
```

{{% alert title="Note" %}}
Expand Down
4 changes: 2 additions & 2 deletions content/en/core/overview/architecture.md
Expand Up @@ -18,11 +18,11 @@ A free and open source NoSQL database we use to store all our data, configuratio

### api

A NodeJS service which runs on the server as a wrapper around CouchDB. It provides security and APIs for browsers and integrations. It also includes a custom implementation of filtered replication to allow it to support more concurrent users. See more at the [Medic API site](https://github.com/medic/medic/tree/master/api) on Github.
A NodeJS service which runs on the server as a wrapper around CouchDB. It provides security and APIs for browsers and integrations. It also includes a custom implementation of filtered replication to allow it to support more concurrent users. See more at the [Medic API site](https://github.com/medic/cht-core/tree/master/api) on Github.

### sentinel

Another NodeJS service running on the server, sentinel performs actions called transitions every time a document in CouchDB is added or modified. Some examples are validations, generating scheduled messages, automatic responses, creating patients, and sending alerts. See more at the [Medic Sentinel site](https://github.com/medic/medic/tree/master/sentinel) on Github.
Another NodeJS service running on the server, sentinel performs actions called transitions every time a document in CouchDB is added or modified. Some examples are validations, generating scheduled messages, automatic responses, creating patients, and sending alerts. See more at the [Medic Sentinel site](https://github.com/medic/cht-core/tree/master/sentinel) on Github.

### PostgreSQL

Expand Down
2 changes: 1 addition & 1 deletion content/en/core/overview/translations.md
Expand Up @@ -32,7 +32,7 @@ New languages must be added and configured in several places:
## Adding new keys
In order to trace the addition of new terms and also updates to existing translations,
the default translation file (messages-en.properties) must be updated directly.
Our GitHub repo provides with a [command line tool (CLI)](https://github.com/medic/medic/tree/master/scripts/poe) to
Our GitHub repo provides with a [command line tool (CLI)](https://github.com/medic/cht-core/tree/master/scripts/poe) to
import updates into the POEditor app.
If you don't have an API token, please contact a Medic developer. Please do not disclose this API token to anyone else.

Expand Down
2 changes: 1 addition & 1 deletion content/en/core/releases/3.0.0.md
Expand Up @@ -133,4 +133,4 @@ Reduce the time it takes to load the Reports and Contacts lists by up to 50% by

## And lots more…

Over 100 individual issues have been fixed in this release - [read more](https://github.com/medic/medic-webapp/blob/master/Changes.md#300).
Over 100 individual issues have been fixed in this release - [read more](https://github.com/medic/cht-core/blob/master/Changes.md#300).
2 changes: 1 addition & 1 deletion content/en/core/releases/3.1.0.md
Expand Up @@ -33,4 +33,4 @@ Private data is now better protected against unauthorized access. [[#2733](https

## And more...

19 individual issues have been fixed in this release - [read more](https://github.com/medic/medic-webapp/blob/master/Changes.md#310).
19 individual issues have been fixed in this release - [read more](https://github.com/medic/cht-core/blob/master/Changes.md#310).
2 changes: 1 addition & 1 deletion content/en/core/releases/3.10.3.md
Expand Up @@ -23,7 +23,7 @@ This release fixes issues around using the default hierarchy and having contact
With configurable hierarchies, introduced in [3.7.0]({{% ref "core/releases/3.7.0.md#configurable-hierarchies" %}}), the `contact_type` property became reserved to determine the type of contact.
However, projects could have used this property for internal logic in their configuration code before upgrading to 3.7, and could have contacts that have this property along with a default hierarchy type.

The complete solution for these issues requires an upgrade to this release and recompiling and redeploying `app_settings` with [medic-conf 3.4.1](https://github.com/medic/medic-conf/blob/master/release-notes.md#340) or greater.
The complete solution for these issues requires an upgrade to this release and recompiling and redeploying `app_settings` with [medic-conf 3.4.1](https://github.com/medic/cht-conf/blob/master/release-notes.md#340) or greater.

### Breaking changes

Expand Down
2 changes: 1 addition & 1 deletion content/en/core/releases/3.8.0.md
Expand Up @@ -16,7 +16,7 @@ No known issues.
### Breaking changes

The changes to [tasks and targets](#task-and-target-data-available-for-analysis) require a "3.8 compatible" partner configurations to be deployed for the tasks and target tabs to continue to function. You'll see errors on these tabs and the console error `Rules Engine: Updates to the nools schema are required` if the configuration is not compatible with 3.8. All "3.8 compatible" configurations are backward compatible and can be deployed safely to any Core Framework version. It is therefore recommended to deploy the "3.8 compatible" configuration before upgrading so your application will work seamlessly once the upgrade completes.
* For partners using declarative configuration, ensure your configuration is deployed using [medic-conf 3.1.0](https://github.com/medic/medic-conf/blob/master/release-notes.md#31) or greater.
* For partners using declarative configuration, ensure your configuration is deployed using [medic-conf 3.1.0](https://github.com/medic/cht-conf/blob/master/release-notes.md#310) or greater.
* For partners maintaining their configuration in the legacy `rules.nools.js` file, ensure the latest [schema changes](https://forum.communityhealthtoolkit.org/t/v3-9-support-for-legacy-rules-nools-js/1322/2) are deployed.

These changes also result in new constraints for partner application task and target code:
Expand Down
2 changes: 1 addition & 1 deletion content/en/design/components/_index.md
Expand Up @@ -53,7 +53,7 @@ These are the status indication colors of the system. When necessary, use white

<br>

For more information on how these colors are applied in the app, see our [color variables file](https://github.com/medic/medic/blob/master/webapp/src/css/variables.less).
For more information on how these colors are applied in the app, see our [color variables file](https://github.com/medic/cht-core/blob/master/webapp/src/css/variables.less).


## Typography
Expand Down
2 changes: 1 addition & 1 deletion publish_to_ghpages.sh
Expand Up @@ -21,7 +21,7 @@ set -e
# 3. `hugo`
# 4. `cd public && git add --all && git commit -m "Publishing to gh-pages" && cd ..` Feel free to make a pertinent commit message!
# 5. `git push upstream gh-pages`
# 3. Repeat step 2 to update after any changes to master.
# 3. Repeat step 2 to update after any changes to main.
#

if [ "`git status -s`" ]
Expand Down

0 comments on commit 8577f7e

Please sign in to comment.