Update Website

This document explains how a user can log in and create a new event or update a meeting time. This is intended for users who have never worked with Github and assumes a New Website has already been created.

---

Register an Account

In order to be granted access to make any changes, you must create an account.

1. Open https://github.com and click Sign up:

   

2. Provide basic account information:

   

3. Check email and provide the temporary token:

   

4. Either provide demographic information or click Skip personalization:

   

At this point, your account has been created and is ready for use.

You can now contact anyone in charge of the website you would like to help with and provide your account name with a request for access.

Pull Requests

If you have not been provided access to a project and attempt to make changes on a website, Github will automatically create a Fork. This simply means your account now owns a copy of the project, which means you are free to make any changes to your copy.

After making changes to this copy, you can create a Pull Request, which just means you would like the main project to “absorb” your changes. Github provides a web interface for this which is documented on their website.

Responsibility

After a project (website) administrator has given you access to their Team, you will likely be able to make changes directly to the website repository.

NOTICE: Most websites will automatically “build and deploy” (or “publish the changes”) with all file changes. Various safeguards exist to prevent impacting a live/production website–the best safeguard is small/trivial updates that can be easily explained (in the commit title/description).

REMEMBER: We may make mistakes, but we will promptly admit when we become aware of mistakes we have made. We will recognize the earnest effort of others and guide them through mistakes. Open communication will enable us to reach the newcomer.

The Code of Conduct used by this project is offered as a basic template that aims to embody A.A. principles, including respect for others and anonymity.

To accept this responsibility …

1. Open https://github.com, select your user icon, and select Your Organizations:

   

2. Select Join next to the organization/team you have been invited to:

   

3. Read through the disclaimer and choose the appropriate option.

---

Update a Meeting

It is recommended to first read Data Format.

The process to update meetings is very similar to the process required to Create an Event. Meeting information is stored in the data folder, which can either have a single meetings.yaml file, or a directory named meetings/ with any number of ____.yaml files within, each one representing a meeting.

Spaces: These yaml files are a special format that functions very similar to a database. Spaces (NOT TABS) and colons are very important.

Create an Event

To create an event:

1. Navigate to your project:

   

2. Select content, then events:

   

3. The easiest way to proceed is to copy/paste an existing or example document:

   

4. Select the chosen source document and click the Display the source blob button:

   

5. Highlight the document and “copy”. If this is challenging, the Raw button will provide a “plain text” version that is easier to use.

   

6. Back in the events directory, choose Add file > Create new file:

   

7. Paste the starting file contents into the large box and provide a filename above.

Note

This filename should NOT include spaces, keep it simple with numbers, lowercase letters, hyphens, and underscores. The filename MUST end with .md.

8. Update the content as appropriate and provide a short explanation of the change that is being made:

   

9. After clicking the commit button, you can click Actions to observe the website update “build” process:

   

10. Once complete, green checkmarks will be displayed:

11. Your changes will now be available for the world to view: