Contributing to this project

This is a study guide for developers who want to get Acquia certified.

Github

Github has a very convenient set of tools which allow you to easily make changes via the web interface. You can also use the web interface to create a pull request. The easiest way to suggest changes is to use the "Edit this page on GitHub" link at the bottom of each page. This will take you to the source file for the page you are on. You can then click the pencil icon to edit the file.

You can then make your changes and create a pull request. Please make sure that the target branch is gh-pages. This is the branch that is used to build the site.

Alternatively, you could start with forking the repo using the "Fork me" button at the top right of the page. Then you can make changes to your fork and create a pull request.

When you create a pull request, please make sure that the target branch is gh-pages. This is the branch that is used to build the site. I will review the changes and merge them into the site if they are appropriate.

Guidelines/Suggestions

• Please try to ensure that your changes are accurate, relevant, and easy to understand.
• Please pay attention to formatting. The theme should take care of most of that for you.
• Your target audience is Drupal developers who have been developing for Drupal for at least 1 year and are studying for the Acquia certification tests. Please keep this in mind when making changes.
• For links, please specify the date updated in the link text. For example:
  • Views Overview at Drupal.org updated May 2023
• Check out the resources below for markdown guides and Vitepress markdown extensions.
• Be sure to gate your code snippets with the appropriate language. You need to use the triple backticks and specify the language. Note. twig is especially problematic if you don't wrap it in the triple backticks and specify twig. Failing this will cause the page not to be built correctly.
• All images go in /docs/public/images directory and are referred to in markdown using the /images/ path. e.g. ![My Image](/images/my-image.png)

Setting up and running a local copy of the site on your mac

This will let you make edits and see them in real time. It is useful for testing changes before submitting a pull request especially if you want to try some of the cool magic that Vitepress can do. Check out the Vitepress Markdown Extensions for more.

1. Clone the repo to your local e.g. d9book2
2. Install all the requirements with:

nvm install node
npm install -g pnpm
pnpm install

3. Start local dev server with:

pnpm run book:dev

This shows a local URL: http://localhost:5173/. You can click on the link or press the letter o to open it in your browser. Use h for help.

To build your site and check for broken links (which also generates static files in the dist directory), you can use the following:

pnpm run book:build

To update the dependencies, you can use the following:

pnpm update

Resources

• Markdown Guide - A comprehensive guide to Markdown.
• Markdown Cheat Sheet - A quick reference to the Markdown syntax.
• First contributions is a great place to start if you are new to contributing to open source projects.
• Vitepress Markdown Extensions - Vitepress has some cool markdown extensions that are usedin this book to make the content more interesting and interactive.