Overview:

This blog post provides a guide on how to create and publish a blog post on the Coveo technical blog. The blog is built with Jekyll and hosted on GitHub Pages. The post explains the process of forking the repository, adding a blog post, and previewing the changes. It also covers the file structure of the blog and the necessary front matter for each post. Additionally, the post provides instructions for previewing the post locally using Ruby and Jekyll or Docker.

Features:

• Fork the repository and add your blog post on your fork
• Preview your changes at youruser.github.io/source.coveo.com
• Blog posts are written in Markdown and located under the _posts folder
• Front matter should include title, your name, your role within Coveo, and a picture of you
• Tags and Twitter handle can be added at your discretion
• Posts should be prefixed with the date they are meant to be published
• Add a <!-- more --> tag to create a post preview on source.coveo.com
• Preview the post locally using Ruby and Jekyll or Docker

Installation:

To install and use the Coveo theme for the technical blog, follow these steps:

1. Fork the repository: Go to https://github.com/youruser/source.coveo.com and click on the “Fork” button to create a copy of the repository on your GitHub account.

2. Clone the repository: Open a command-line tool (e.g., Terminal on Mac or cmd on Windows) and run the following command:

git clone https://github.com/youruser/source.coveo.com.git

Replace youruser with your own GitHub username. This will create the necessary files in the current directory.

3. Open the folder: Using your preferred code editor, open the folder source.coveo.com that was created by cloning the repository.

4. Create a new blog post: In the _posts folder, create a new Markdown file. Prefix the file name with the date you want to publish the post (e.g., 2021-10-05-mypost.md for October 5th, 2021). Alternatively, you can duplicate an existing post and rename the file.

5. Add front matter: Inside the newly created file, add front matter at the beginning. The front matter should include the title of your blog post, your name, your role within Coveo, and a picture of you. Tags and your Twitter handle can also be added optionally.

6. Add content: After the front matter, write your blog post content using Markdown syntax.

7. Preview locally with Ruby and Jekyll: If you have Ruby and Jekyll installed, you can run the following command from your folder:

bundle exec jekyll serve

This will start a local server, and you can preview your post at http://localhost:4000.

8. Preview locally with Docker: Alternatively, if you have Docker installed, you can run the following command from the root of your repository:

docker run --platform linux/amd64 --volume=$(pwd):/srv/jekyll -p 4000:4000 jekyll/jekyll:4.2.0 jekyll server

If you encounter permission denied errors, delete the .jekyll-cache and _site folders, as they will get regenerated by Jekyll.

Summary:

This blog post provides a comprehensive guide on how to create and publish a blog post on the Coveo technical blog. It covers the process of forking the repository, adding a blog post, and previewing the changes. The post also explains the necessary front matter for each post and provides instructions for previewing the post locally using Ruby and Jekyll or Docker. By following these steps, users can easily contribute their own blog posts to the Coveo technical blog.