Compare commits
19 Commits
d0de9b5c6a
...
v1.0
Author | SHA1 | Date | |
---|---|---|---|
2b63732480 | |||
7653fcd05b | |||
d4d01a9c8f | |||
ef2fae024f | |||
8fc853b309 | |||
098970d877 | |||
9ab05711f3 | |||
5f3d41f8cb | |||
8cd36acfeb | |||
cb2b0e87df | |||
259a7fe7e2 | |||
a7bd749c1a | |||
055e32abab | |||
2b38f0f053 | |||
dc741450df | |||
a3ebb66979 | |||
6c882fe7e7 | |||
5b1120db68 | |||
4d17933dd9 |
26
README.md
26
README.md
@@ -1,15 +1,23 @@
|
|||||||
# MarkdownResume-Pipeline-ClientExample
|
# MarkdownResume-Pipeline-ClientExample
|
||||||
|
|
||||||
Example client repository for using the [MarkdownResume-Pipeline](https://git.knownelement.com/reachableceo/MarkdownResume-Pipeline) vendored repository.
|
Example client repository for using the [MarkdownResume-Pipeline](https://git.knownelement.com/reachableceo/MarkdownResume-Pipeline) resume building
|
||||||
|
microservice. The microservice is vendored into this repository.
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
I recommend doing these steps in order for efficency.
|
### Runtime Requirements
|
||||||
|
|
||||||
- Edit local/build/build-resume.sh and edit the values in the top section to refelct your information.
|
- Bash (this entire project was developed on msys2 on Windows 10)
|
||||||
- Edit local/Templates/WorkHistory/WorkHistory.csv
|
- Ensure you have pandoc installed and in your path.
|
||||||
- Create local/Templates/JobHistoryDetails/<position>.md to match the value in the first field of WorkHistory.csv
|
|
||||||
- Edit local/Templates/SkillsAndProjects/Projects.md
|
### Steps
|
||||||
- Edit local/Template/SkillsAndProjects/Skills.csv
|
|
||||||
- Edit local/Templates/CandidateInfoSheet.md
|
- Edit local/build/CandidateVariables.env to refelct your information.
|
||||||
- cd to the local/build directory and run bash build-resume.sh
|
- Edit local/Templates/MarkdownResume/WorkHistory/WorkHistory.csv
|
||||||
|
- Create and edit local/Templates/MarkdownResume/JobHistoryDetails/<position>.md to match the value in the first field of WorkHistory.csv
|
||||||
|
- Repeat as necessary for your job history.
|
||||||
|
- Edit local/Templates/MarkdownResume/SkillsAndProjects/Projects.md
|
||||||
|
- Edit local/Template/MarkdownResume/SkillsAndProjects/Skills.csv
|
||||||
|
- Edit local/Templates/MarkdownResume/CandidateInfoSheet.md
|
||||||
|
- cd to the local/build directory and run bash build-demo-markdown.sh
|
||||||
|
- Examine the PDF/MSWord output in local/build-output/*
|
||||||
|
3
local/Templates/JSONResume/certificates.csv
Normal file
3
local/Templates/JSONResume/certificates.csv
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# CSV File: certificates.csv
|
||||||
|
# Columns: name,date,issuer,url
|
||||||
|
Certified Kubernetes Administrator,2021-05-01,Cloud Native Computing Foundation,http://certificates.com/kubernetes
|
|
3
local/Templates/JSONResume/education.csv
Normal file
3
local/Templates/JSONResume/education.csv
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
institution,url,area,studyType,startDate,endDate,score,courses
|
||||||
|
"The University of Queensland",,"Software Engineering (incomplete)","Bachelors","2008-02-12","2009-12-12",,
|
||||||
|
"University of Technology","http://universityoftechnology.com","Computer Science","Bachelor","2010-09-01","2014-06-30","3.8 GPA","CS101 - Introduction to Computer Science; CS201 - Data Structures and Algorithms; CS301 - Operating Systems"
|
|
@@ -45,6 +45,16 @@ export SourceCode="https://git.knownelement.com/reachableceo/MarkdownResume-Pipe
|
|||||||
export URLCOLOR="blue"
|
export URLCOLOR="blue"
|
||||||
export PAGEBACKGROUND="./background3.pdf"
|
export PAGEBACKGROUND="./background3.pdf"
|
||||||
export JSONRESUME_THEME="professional"
|
export JSONRESUME_THEME="professional"
|
||||||
|
export PANDOC_TEMPLATE="eisvogel"
|
||||||
|
|
||||||
|
###########################
|
||||||
|
# Yaml files used by pandoc
|
||||||
|
###########################
|
||||||
|
|
||||||
|
export YamlInputTemplateFileCandidateInfoSheet="$PipelineClientWorkingDir/build/BuildTemplate-CandidateInfoSheet.yml"
|
||||||
|
export YamlInputTemplateFileJobBoard="$PipelineClientWorkingDir/build/BuildTemplate-JobBoard.yml"
|
||||||
|
export YamlInputTemplateFileClientSubmission="$PipelineClientWorkingDir/build/BuildTemplate-ClientSubmission.yml"
|
||||||
|
export WordOutputReferenceDoc="$PipelineClientWorkingDir/build/resume-docx-reference.docx"
|
||||||
|
|
||||||
##########################
|
##########################
|
||||||
# Candidate info sheet
|
# Candidate info sheet
|
||||||
|
@@ -1,62 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
|
|
||||||
# This is a demo script for the MarkdownResumePipeline server
|
|
||||||
# This script creates PDF/MSWord output from markdown/csv input
|
|
||||||
|
|
||||||
|
|
||||||
############################################
|
|
||||||
#Edit this file to reflect your information
|
|
||||||
############################################
|
|
||||||
|
|
||||||
source "./CandidateVariables.env"
|
|
||||||
|
|
||||||
####################################################
|
|
||||||
####################################################
|
|
||||||
####################################################
|
|
||||||
#DO NOT CHANGE ANYTHING BELOW THIS LINE
|
|
||||||
####################################################
|
|
||||||
####################################################
|
|
||||||
####################################################
|
|
||||||
|
|
||||||
######################################################################################
|
|
||||||
# Setup key variables that will be used by the build-pipeline-server-markdown.sh script
|
|
||||||
######################################################################################
|
|
||||||
|
|
||||||
export MO_PATH="bash ../../vendor/git.knownelement.com/ExternalVendorCode/mo/mo"
|
|
||||||
|
|
||||||
export BUILD_TEMP_DIR="$PipelineClientWorkingDir/build-temp/MarkdownResume"
|
|
||||||
export BUILD_OUTPUT_DIR="$PipelineClientWorkingDir/build-output/MarkdownResume"
|
|
||||||
|
|
||||||
export BUILDYAML_JOBBOARD="$BUILD_TEMP_DIR/JobBoard.yml"
|
|
||||||
export BUILDYAML_CLIENTSUBMISSION="$BUILD_TEMP_DIR/ClientSubmission.yml"
|
|
||||||
export BUILDYAML_CANDIDATEINFOSHEET="$BUILD_TEMP_DIR/CandidateInfoSheet.yml"
|
|
||||||
|
|
||||||
export CandidateInfoSheetMarkdownOutputFile="$BUILD_OUTPUT_DIR/recruiter/CandidateInfoSheet.md"
|
|
||||||
export CandidateInfoSheetPDFOutputFile="$BUILD_OUTPUT_DIR/recruiter/CandidateInfoSheet.pdf"
|
|
||||||
|
|
||||||
export JobBoardMarkdownOutputFile="$BUILD_OUTPUT_DIR/job-board/Candidate-Resume.md"
|
|
||||||
export JobBoardPDFOutputFile="$BUILD_OUTPUT_DIR/job-board/Candidate-Resume.pdf"
|
|
||||||
export JobBoardMSWordOutputFile="$BUILD_OUTPUT_DIR/job-board/Candidate-Resume.doc"
|
|
||||||
|
|
||||||
export ClientSubmissionMarkdownOutputFile="$BUILD_OUTPUT_DIR/client-submit/Candidate-Resume.md"
|
|
||||||
export ClientSubmissionPDFOutputFile="$BUILD_OUTPUT_DIR/client-submit/Candidate-Resume.pdf"
|
|
||||||
export ClientSubmissionMSWordOutputFile="$BUILD_OUTPUT_DIR/client-submit/Candidate-Resume.doc"
|
|
||||||
|
|
||||||
echo "Cleaning up from previous runs..."
|
|
||||||
|
|
||||||
rm $BUILDYAML_CANDIDATEINFOSHEET
|
|
||||||
rm $CandidateInfoSheetMarkdownOutputFile
|
|
||||||
rm $CandidateInfoSheetPDFOutputFile
|
|
||||||
|
|
||||||
rm $BUILDYAML_JOBBOARD
|
|
||||||
rm $JobBoardMarkdownOutputFile
|
|
||||||
rm $JobBoardPDFOutputFile
|
|
||||||
rm $JobBoardMSWordOutputFile
|
|
||||||
|
|
||||||
rm $BUILDYAML_CLIENTSUBMISSION
|
|
||||||
rm $ClientSubmissionMarkdownOutputFile
|
|
||||||
rm $ClientSubmissionPDFOutputFile
|
|
||||||
rm $ClientSubmissionMSWordOutputFile
|
|
||||||
|
|
||||||
bash ../../vendor/git.knownelement.com/reachableceo/MarkdownResume-Pipeline/build/build-pipeline-server-markdown.sh
|
|
@@ -1,5 +1,7 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
#####################################################################################################
|
#####################################################################################################
|
||||||
#Markdown to PDF/MSWord Resumek and candidate info sheet
|
#Markdown to PDF/MSWord Resumek and candidate info sheet
|
||||||
#####################################################################################################
|
#####################################################################################################
|
||||||
@@ -8,7 +10,11 @@
|
|||||||
# Create the candidate information PDF
|
# Create the candidate information PDF
|
||||||
#############################################
|
#############################################
|
||||||
|
|
||||||
$MO_PATH $PipelineClientWorkingDir/build/BuildTemplate-CandidateInfoSheet.yml > $BUILDYAML_CANDIDATEINFOSHEET
|
# Expand variables into rendered YAML files. These will be used by pandoc to create the output artifacts
|
||||||
|
|
||||||
|
$MO_PATH $YamlInputTemplateFileJobBoard > $BUILDYAML_JOBBOARD
|
||||||
|
$MO_PATH $YamlInputTemplateFileClientSubmission > $BUILDYAML_CLIENTSUBMISSION
|
||||||
|
$MO_PATH $YamlInputTemplateFileClientSubmission > $BUILDYAML_CANDIDATEINFOSHEET
|
||||||
|
|
||||||
echo "Creating candidate info sheet..."
|
echo "Creating candidate info sheet..."
|
||||||
|
|
||||||
@@ -16,16 +22,13 @@ $MO_PATH $PipelineClientWorkingDir/Templates/MarkdownResume/CandidateInfoSheet/C
|
|||||||
|
|
||||||
pandoc \
|
pandoc \
|
||||||
"$CandidateInfoSheetMarkdownOutputFile" \
|
"$CandidateInfoSheetMarkdownOutputFile" \
|
||||||
--template eisvogel \
|
--template $PANDOC_TEMPLATE \
|
||||||
--metadata-file="$PipelineClientWorkingDir/build-temp/MarkdownResume/CandidateInfoSheet.yml" \
|
--metadata-file="$BUILDYAML_CANDIDATEINFOSHEET" \
|
||||||
--from markdown \
|
--from markdown \
|
||||||
--to=pdf \
|
--to=pdf \
|
||||||
--output $CandidateInfoSheetPDFOutputFile
|
--output $CandidateInfoSheetPDFOutputFile
|
||||||
|
|
||||||
# Expand variables into rendered YAML files. These will be used by pandoc to create the output artifacts
|
|
||||||
|
|
||||||
$MO_PATH $PipelineClientWorkingDir/build/BuildTemplate-JobBoard.yml > $BUILDYAML_JOBBOARD
|
|
||||||
$MO_PATH $PipelineClientWorkingDir/build/BuildTemplate-ClientSubmission.yml > $BUILDYAML_CLIENTSUBMISSION
|
|
||||||
|
|
||||||
echo "Combining markdown files into single input file for pandoc..."
|
echo "Combining markdown files into single input file for pandoc..."
|
||||||
|
|
||||||
@@ -124,38 +127,38 @@ echo "Generating PDF output for job board version..."
|
|||||||
|
|
||||||
pandoc \
|
pandoc \
|
||||||
"$JobBoardMarkdownOutputFile" \
|
"$JobBoardMarkdownOutputFile" \
|
||||||
--template eisvogel \
|
--template $PANDOC_TEMPLATE \
|
||||||
--metadata-file="$PipelineClientWorkingDir/build-temp/MarkdownResume/JobBoard.yml" \
|
--metadata-file="$BUILDYAML_JOBBOARD" \
|
||||||
--from markdown \
|
--from markdown \
|
||||||
--to=pdf \
|
--to=pdf \
|
||||||
--output "$JobBoardPDFOutputFile"
|
--output "$JobBoardPDFOutputFile"
|
||||||
|
|
||||||
echo "Generating MSWord output for job board version..."
|
|
||||||
|
|
||||||
pandoc \
|
|
||||||
"$JobBoardMarkdownOutputFile" \
|
|
||||||
--metadata-file="$PipelineClientWorkingDir/build-temp/MarkdownResume/JobBoard.yml" \
|
|
||||||
--from markdown \
|
|
||||||
--to=docx \
|
|
||||||
--reference-doc="$PipelineClientWorkingDir/build/resume-docx-reference.docx" \
|
|
||||||
--output "$JobBoardMSWordOutputFile"
|
|
||||||
|
|
||||||
echo "Generating PDF output for client submission version..."
|
echo "Generating PDF output for client submission version..."
|
||||||
|
|
||||||
pandoc \
|
pandoc \
|
||||||
"$ClientSubmissionMarkdownOutputFile" \
|
"$ClientSubmissionMarkdownOutputFile" \
|
||||||
--template eisvogel \
|
--template "$PANDOC_TEMPLATE" \
|
||||||
--metadata-file="$PipelineClientWorkingDir/build-temp/MarkdownResume/ClientSubmission.yml" \
|
--metadata-file="$BUILDYAML_CLIENTSUBMISSION" \
|
||||||
--from markdown \
|
--from markdown \
|
||||||
--to=pdf \
|
--to=pdf \
|
||||||
--output "$ClientSubmissionPDFOutputFile"
|
--output "$ClientSubmissionPDFOutputFile"
|
||||||
|
|
||||||
|
echo "Generating MSWord output for job board version..."
|
||||||
|
|
||||||
|
pandoc \
|
||||||
|
"$JobBoardMarkdownOutputFile" \
|
||||||
|
--metadata-file="$BUILDYAML_JOBBOARD" \
|
||||||
|
--from markdown \
|
||||||
|
--to=docx \
|
||||||
|
--reference-doc="$WordOutputReferenceDoc" \
|
||||||
|
--output "$JobBoardMSWordOutputFile"
|
||||||
|
|
||||||
echo "Generating MSWord output for client submission version..."
|
echo "Generating MSWord output for client submission version..."
|
||||||
|
|
||||||
pandoc \
|
pandoc \
|
||||||
"$ClientSubmissionMarkdownOutputFile" \
|
"$ClientSubmissionMarkdownOutputFile" \
|
||||||
--metadata-file="$PipelineClientWorkingDir/build-temp/MarkdownResume/ClientSubmission.yml" \
|
--metadata-file="$BUILDYAML_CLIENTSUBMISSION" \
|
||||||
--from markdown \
|
--from markdown \
|
||||||
--to=docx \
|
--to=docx \
|
||||||
--reference-doc="$PipelineClientWorkingDir/build/resume-docx-reference.docx" \
|
--reference-doc="$WordOutputReferenceDoc" \
|
||||||
--output "$ClientSubmissionMSWordOutputFile"
|
--output "$ClientSubmissionMSWordOutputFile"
|
Reference in New Issue
Block a user