Quickstart

This quickstart guide will walk you through how to edit existing pages on the Nameless wiki.

For new contributors, it’s best to start with editing your character’s page! If your character doesn’t already have a page, open an issue and we will make you one ASAP.

Access the Files

  1. Sign up for an account on http://github.com/.
  2. DM Vinnie (@lanfect on Discord) or reply to the #Let’s Build A Wiki Thread with your github username or email address.
  3. Vinnie will add you to the BitD organization https://github.com/organizations/BitD-Philly/, which will give you permissions to edit and upload files.

The files used to build the website are located in the Github repository here: http://github.com/bitd-philly/bitd-philly.github.io. You can view and download them without being a member of the organization, but you cannot contribute content to them until you are.

Edit an existing page

  1. Navigate to the bitd-philly.github.io repository in the BitD-Philly Github Organization.
  2. Switch to the content branch.
  3. Click the all_collections folder. This folder will contain all the wiki pages that are sorted into various collections. The collections that contain wiki content are _player_characters, _npcs, _factions, and _locations. (More may be added later!)
  4. Navigate to the collection page you want to edit. If you’re just starting out, find your character page! It will be in the all_collections/_player_characters folder. If your character sheet is not there, open an issue and a more experienced contributor will set one up for you!
  5. Click the pencil icon to open the editing interface.
  6. Make changes to the file.

    When first editing, it’s adviseable to not edit anything marked as “required” in the “front matter” (the text between the dashed lines at the top of the file). This part of the page is metadata that is used to build your character page and reference your character in different places across the entire website!

Save Changes

  1. Click the green “Commit changes…” button.
  2. Sign off on the commit, adding an extended description if desired.
  3. Click “Sign off and commit changes”.
  4. Continue editing, committing changes as needed.

Note that these changes will not reflect in the website immediately. You can think of commits as “saving” your changes, but they will not be “published” until you or another contributor creates a pull request to merge your changes into the website code.

Publish Changes

Submit Pull Request

  1. When you see this banner when on the content branch, it means there are outstanding changes that can be published.
  2. Click “Contribute > Open Pull Request”.
  3. Ensure the top bar looks like this:
    Specifically, it should read:
    • “base: gh-pages” in the left dropdown
    • “compare: content” in the right dropdown
    • “Able to merge.” with a check mark.
  4. Add a title and click “Create Pull Request”.
  5. You should see a page that looks like this:
  6. Wait for your edits to be approved by another contributor to the BitD wiki.

Generally, the reviewer should also merge the pull request once the changes are approved. If they do not, you can follow the next steps to initiate the publishing process yourself.

Merge Pull Request

  1. Click the arrow next to “Merge Pull Request” to ensure “Create a merge commit” is selected.

  2. Click the Merge pull request button.
  3. Click Confirm Merge.

Congratulations! Your changes will be published to the website after about 2-3 minutes.