feat: docs to publish new talk

Aravinth Manivannan 2022-04-24 20:52:06 +05:30
parent 4da81ad09f
commit 07f93f35ff
Signed by: realaravinth
GPG Key ID: AD9F0F08E855ED88
1 changed files with 65 additions and 0 deletions

docs/new-talk.md Normal file
View File

@ -0,0 +1,65 @@
# Add new blog post
1. Create new directory at
`/content/talks/yyyy-mm-dd-talk-title-event-name` and `index.md` in
the same directory and populate with the following metadata:
title = "title of the talk"
date = "yyyy-mm-dd"
description = "description of talk, will be displayed in talk listing"
tags = ['hostea']
# **Only use author nicks in blog post Markdown files, it is used to lookup author details.**
author = 'imbatman' # speaker nickname
2. Add author details in [`config.toml`](../config.toml) in `authors`
under `extra` section:
# Put all your custom variables here
authors = [
{ "nick"="imbatman", name="Batman", "website"="https://batman.example.org" },
{ "nick"="superman", name="Superman", "website" ="https://superman.example.org" }
This information is used to render speaker and author information in
talks and blog posts respectively. **Only use author nicks in talks post
Markdown files, it is used to lookup author details.**
3. Add content to about the talk to the file created in step 1.
4. Add talk-related resources like slides and related material in the
directory created in step 1. They will be accessible via relative
URLs. For instance:
➜ website git:(master) ✗ tree content/talks/22-04-2022-hostea-introducing-hostea-forgefriends-monthly-meet
├── index.md
└── slides
├── 2022-04-22-forgefriends-introducing-hostea.odp
└── 2022-04-22-forgefriends-introducing-hostea.pdf
1 directory, 3 files
## Resources
- [slides(ODP)](./slides/2022-04-22-forgefriends-introducing-hostea.odp)
- [slides(PDF)](./slides/2022-04-22-forgefriends-introducing-hostea.pdf)
**WARNING: Don't storing large images or videos in Git repositories,
using content hosting services and link to them**
5. Commit and push to deploy talk details! 🎉