• Sogilis Blog
• How to write a new article?
  • 🌍 Online
  • 🔌 Offline
    • ☑️ Prerequisites
    • ⬇️ Download blog
    • ▶️ Start the blog
      • 🤘 Without Docker
      • 🐳 With Docker
    • ✏️ Write a new article
    • ✉️ Publish your article
• Notes for developers (not for writers of articles)
• Credits

Sogilis Blog

Welcome to the open source Blog of Sogilis ! It is alive with following url:

• https://blog.sogilis.com

ℹ️ For the moment, all is in french. ℹ️ All articles regardless their languages are visible in all languages.

The backlog is available in Github project.

How to write a new article?

Do not hesitate to ask help. We answer with enjoy :-) !

🌍 Online

1. Go to https://blog.sogilis.com/admin, and sign in.

2. That's it. You can now create/modify/review/delete/publish articles.

🔌 Offline

These instructions will get you a copy of the project up and running on your local machine.

So you will be able to write a new article offline.

☑️ Prerequisites

You will need to install the following software:

• GNU Make

• Git

• Alternative 1 (without docker)

  1. NodeJS >= 12
  2. Yarn

• Alternative 2 : docker (more details here).

⬇️ Download blog

git clone [email protected]:sogilis/Blog.git
cd Blog

▶️ Start the blog

With the both methods, each time you save a change on an article, the local website is updated (live reload).

🤘 Without Docker

1. Start the blog:

make start

Wait a few seconds then, go to http://localhost:1313.

🐳 With Docker

1. Create the docker image (only once. see docker considerations):

make docker-build

2. Start the blog and the watcher:

make docker-start

Wait a few seconds then, go to http://localhost:1313.

3. Eventually, see logs (especially if there is a problem):

make docker-logs

4. Stop the container with:

make docker-stop

✏️ Write a new article

⚠️ The branch master is automatically pushed on the production server, you need to work on a new branch and use the Pull Request mechanism. ⚠️

1. Create a new branch

2. Write your article:

   Create a new .md file in site/content/posts. Only Markdown is supported with following syntax (more details here).

   Here is a basic markdown template to start with:

   ---
   title: My article title
   author: Author ([email protected])
   date: 2020-08-20
   image: /img/image-name.jpeg
   altimage: description and credits of the image
   categories:
     - cat1
     - cat2
     - ...
   tags:
     - tag1
     - tag2
     - ...
   ---
   
   ## A first subtitle
   
   Start writing your content here.

   Note that:

   • the date should not be later than the current date, otherwise the article will not be published (and therefore not visible from the home page in the article list)
   • you can set any values to categories and tags. Look at values that have been used in previous articles to avoid duplicates
   • put your images under the site/static/img/ directory
   • 🧰 See tools for writing.

3. See the result at http://localhost:1313

4. Finalize your article, and see the output in real time.

✉️ Publish your article

1. Create a new Pull Request to get feedbacks from other team members.

   ℹ️ Netlify provides a preview environment.

   So when you open your Pull Request Netlify builds the new website and you can check the result of your Pull Request in Netlifly. See deploy-preview jobs triggered by your Pull Request to get the corresponding url.

2. If you're satisfied with the result in the preview you can merge the Pull Request into master branch.

3. It's done, the deployment is automated.

Credits

Articles are created by Sogilis collaborators