From cacb3250e628bf0185694ab69e53410e5bfdb689 Mon Sep 17 00:00:00 2001 From: Favour Kelvin Date: Wed, 4 Oct 2023 18:45:24 +0000 Subject: [PATCH] Deploy website - based on e198d897789c1357ae76a4bb1fa563e8e726996b --- 404.html | 4 ++-- assets/js/{34914372.9993729f.js => 34914372.eff13be1.js} | 2 +- assets/js/8d7b424f.a0a67a4f.js | 1 + assets/js/8d7b424f.caec00b9.js | 1 - assets/js/{935f2afb.a069ca25.js => 935f2afb.f568945b.js} | 2 +- assets/js/{c335d7b4.47080be1.js => c335d7b4.e6f7d1c9.js} | 2 +- assets/js/runtime~main.1c882dd9.js | 1 + assets/js/runtime~main.85cacaa3.js | 1 - blog/archive/index.html | 4 ++-- blog/first-blog-post/index.html | 4 ++-- blog/index.html | 4 ++-- blog/long-blog-post/index.html | 4 ++-- blog/mdx-blog-post/index.html | 4 ++-- blog/tags/docusaurus/index.html | 4 ++-- blog/tags/facebook/index.html | 4 ++-- blog/tags/hello/index.html | 4 ++-- blog/tags/hola/index.html | 4 ++-- blog/tags/index.html | 4 ++-- blog/welcome/index.html | 4 ++-- docs/category/writing-samples/index.html | 6 +++--- docs/intro/index.html | 4 ++-- docs/new/index.html | 4 ++-- docs/writing-sample/api/index.html | 4 ++-- docs/writing-sample/blogs/index.html | 4 ++-- docs/writing-sample/faqs/index.html | 6 +++--- docs/writing-sample/how-to-guide/index.html | 6 +++--- docs/writing-sample/newsletter/index.html | 4 ++-- docs/writing-sample/release-notes/index.html | 8 ++++---- docs/writing-sample/tutorial/index.html | 4 ++-- docs/writing-sample/user-manual/index.html | 4 ++-- index.html | 4 ++-- markdown-page/index.html | 4 ++-- 32 files changed, 60 insertions(+), 60 deletions(-) rename assets/js/{34914372.9993729f.js => 34914372.eff13be1.js} (95%) create mode 100644 assets/js/8d7b424f.a0a67a4f.js delete mode 100644 assets/js/8d7b424f.caec00b9.js rename assets/js/{935f2afb.a069ca25.js => 935f2afb.f568945b.js} (79%) rename assets/js/{c335d7b4.47080be1.js => c335d7b4.e6f7d1c9.js} (94%) create mode 100644 assets/js/runtime~main.1c882dd9.js delete mode 100644 assets/js/runtime~main.85cacaa3.js diff --git a/404.html b/404.html index 2928fada..9380f397 100644 --- a/404.html +++ b/404.html @@ -5,13 +5,13 @@ Page Not Found | Hi, I am Favour Kelvin - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/34914372.9993729f.js b/assets/js/34914372.eff13be1.js similarity index 95% rename from assets/js/34914372.9993729f.js rename to assets/js/34914372.eff13be1.js index ce2c1980..df41025c 100644 --- a/assets/js/34914372.9993729f.js +++ b/assets/js/34914372.eff13be1.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[3877],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>g});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=s(n),d=r,g=u["".concat(p,".").concat(d)]||u[d]||m[d]||o;return n?a.createElement(g,i(i({ref:t},c),{},{components:n})):a.createElement(g,i({ref:t},c))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=d;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[u]="string"==typeof e?e:r,i[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>l,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const o={sidebar_position:3,sidebar_label:"How-to Guides"},i="How-to Guide Documentation Sample",l={unversionedId:"writing-sample/how-to-guide",id:"writing-sample/how-to-guide",title:"How-to Guide Documentation Sample",description:"Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:",source:"@site/docs/writing-sample/how-to-guide.md",sourceDirName:"writing-sample",slug:"/writing-sample/how-to-guide",permalink:"/docs/writing-sample/how-to-guide",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/writing-sample/how-to-guide.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3,sidebar_label:"How-to Guides"},sidebar:"tutorialSidebar",previous:{title:"Tutorials",permalink:"/docs/writing-sample/tutorial"},next:{title:"Blogs and Articles",permalink:"/docs/writing-sample/blogs"}},p={},s=[{value:"Project: Deploying a Voting Smart Contract Dapp on Calimero",id:"project-deploying-a-voting-smart-contract-dapp-on-calimero",level:3},{value:"How-to-Guide Documentation Sample Docs",id:"how-to-guide-documentation-sample-docs",level:2}],c={toc:s},u="wrapper";function m(e){let{components:t,...n}=e;return(0,r.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"how-to-guide-documentation-sample"},"How-to Guide Documentation Sample"),(0,r.kt)("p",null,"Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:"),(0,r.kt)("h3",{id:"project-deploying-a-voting-smart-contract-dapp-on-calimero"},"Project: Deploying a Voting Smart Contract Dapp on Calimero"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Description:")," Crafted a comprehensive how-to guide to walk users through the process of deploying a voting smart contract Dapp on the Calimero network."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Role:")," Lead Technical Writer"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Approach:")," Prioritized user-friendliness and clarity in presenting the steps. The guide is designed to enable even novice users to deploy a voting Dapp successfully on the Calimero network."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Key Sections:")),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Prerequisites:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Listed the requirements before beginning the deployment process, including setting up a Calimero private shard and installing necessary tools."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 1: Build the Smart Contract:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Explained how to clone the Calimero examples repository, navigate to the private directory, and compile the Rust smart contract to WASM."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 2: Generate an Auth Token:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Guided users in generating a Calimero auth token to authenticate and authorize external applications."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 3: Set Up the NEAR CLI:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Provided instructions on how to set up the NEAR CLI for interaction with the Calimero shard."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 4: Create a Keypair:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Detailed the process of creating a keypair for the shard account and locating the generated keypair file."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 5: Create a Sub Account:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Guided users in creating a sub account from the Custodial account in the Calimero Console and adding a public key."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 6: Deploy Your NEAR Contract:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Explained the deployment process, including setting variables, running the deployment command, and checking the deployed contract."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 7: Update the Config File and Start the Dapp Frontend:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Provided instructions for configuring the Dapp frontend, including connection settings and starting the localhost server."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Conclusion:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Summarized the deployment process and congratulated users on successfully deploying a voting application on the Calimero Network.")))),(0,r.kt)("h2",{id:"how-to-guide-documentation-sample-docs"},"How-to-Guide Documentation Sample Docs"),(0,r.kt)("iframe",{width:"100%",height:"800",src:"/img/pdf/voting-tutorial"}),(0,r.kt)("p",null,"If you're interested in collaborating on similar projects or would like more details, feel free to ",(0,r.kt)("a",{parentName:"p",href:"mailto:favourkelvin17@gmail.com"},"contact me"),". I'm excited to discuss how I can assist in creating effective how-to guides for your technical endeavors!"))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[3877],{3905:(e,t,n)=>{n.d(t,{Zo:()=>c,kt:()=>g});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=a.createContext({}),s=function(e){var t=a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=s(e.components);return a.createElement(p.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,p=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=s(n),d=r,g=u["".concat(p,".").concat(d)]||u[d]||m[d]||o;return n?a.createElement(g,i(i({ref:t},c),{},{components:n})):a.createElement(g,i({ref:t},c))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=d;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l[u]="string"==typeof e?e:r,i[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>p,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>l,toc:()=>s});var a=n(7462),r=(n(7294),n(3905));const o={sidebar_position:3,sidebar_label:"How-to Guides"},i="How-to Guide Documentation Sample",l={unversionedId:"writing-sample/how-to-guide",id:"writing-sample/how-to-guide",title:"How-to Guide Documentation Sample",description:"Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:",source:"@site/docs/writing-sample/how-to-guide.md",sourceDirName:"writing-sample",slug:"/writing-sample/how-to-guide",permalink:"/docs/writing-sample/how-to-guide",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/writing-sample/how-to-guide.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3,sidebar_label:"How-to Guides"},sidebar:"tutorialSidebar",previous:{title:"Tutorials",permalink:"/docs/writing-sample/tutorial"},next:{title:"Blogs and Articles",permalink:"/docs/writing-sample/blogs"}},p={},s=[{value:"Project: Deploying a Voting Smart Contract Dapp on Calimero",id:"project-deploying-a-voting-smart-contract-dapp-on-calimero",level:3},{value:"How-to-Guide Documentation Sample Docs",id:"how-to-guide-documentation-sample-docs",level:2}],c={toc:s},u="wrapper";function m(e){let{components:t,...n}=e;return(0,r.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"how-to-guide-documentation-sample"},"How-to Guide Documentation Sample"),(0,r.kt)("p",null,"Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:"),(0,r.kt)("h3",{id:"project-deploying-a-voting-smart-contract-dapp-on-calimero"},"Project: Deploying a Voting Smart Contract Dapp on Calimero"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Description:")," Crafted a comprehensive how-to guide to walk users through the process of deploying a voting smart contract Dapp on the Calimero network."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Role:")," Lead Technical Writer"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Approach:")," Prioritized user-friendliness and clarity in presenting the steps. The guide is designed to enable even novice users to deploy a voting Dapp successfully on the Calimero network."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Key Sections:")),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Prerequisites:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Listed the requirements before beginning the deployment process, including setting up a Calimero private shard and installing necessary tools."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 1: Build the Smart Contract:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Explained how to clone the Calimero examples repository, navigate to the private directory, and compile the Rust smart contract to WASM."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 2: Generate an Auth Token:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Guided users in generating a Calimero auth token to authenticate and authorize external applications."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 3: Set Up the NEAR CLI:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Provided instructions on how to set up the NEAR CLI for interaction with the Calimero shard."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 4: Create a Keypair:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Detailed the process of creating a keypair for the shard account and locating the generated keypair file."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 5: Create a Sub Account:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Guided users in creating a sub account from the Custodial account in the Calimero Console and adding a public key."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 6: Deploy Your NEAR Contract:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Explained the deployment process, including setting variables, running the deployment command, and checking the deployed contract."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Step 7: Update the Config File and Start the Dapp Frontend:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Provided instructions for configuring the Dapp frontend, including connection settings and starting the localhost server."))),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Conclusion:")),(0,r.kt)("ul",{parentName:"li"},(0,r.kt)("li",{parentName:"ul"},"Summarized the deployment process and congratulated users on successfully deploying a voting application on the Calimero Network.")))),(0,r.kt)("h2",{id:"how-to-guide-documentation-sample-docs"},"How-to-Guide Documentation Sample Docs"),(0,r.kt)("iframe",{width:"100%",height:"800",src:"/img/pdf/voting-tutorial.pdf"}),(0,r.kt)("p",null,"If you're interested in collaborating on similar projects or would like more details, feel free to ",(0,r.kt)("a",{parentName:"p",href:"mailto:favourkelvin17@gmail.com"},"contact me"),". I'm excited to discuss how I can assist in creating effective how-to guides for your technical endeavors!"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8d7b424f.a0a67a4f.js b/assets/js/8d7b424f.a0a67a4f.js new file mode 100644 index 00000000..9c7a095a --- /dev/null +++ b/assets/js/8d7b424f.a0a67a4f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6368],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>f});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),u=c(r),d=o,f=u["".concat(l,".").concat(d)]||u[d]||m[d]||a;return r?n.createElement(f,i(i({ref:t},p),{},{components:r})):n.createElement(f,i({ref:t},p))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:o,i[1]=s;for(var c=2;c{r.r(t),r.d(t,{assets:()=>l,contentTitle:()=>i,default:()=>m,frontMatter:()=>a,metadata:()=>s,toc:()=>c});var n=r(7462),o=(r(7294),r(3905));const a={sidebar_position:8,sidebar_label:"Release Notes"},i="Welcome to my Release Note Writing Portfolio Section",s={unversionedId:"writing-sample/release-notes",id:"writing-sample/release-notes",title:"Welcome to my Release Note Writing Portfolio Section",description:"As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users.",source:"@site/docs/writing-sample/release-notes.md",sourceDirName:"writing-sample",slug:"/writing-sample/release-notes",permalink:"/docs/writing-sample/release-notes",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/writing-sample/release-notes.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8,sidebar_label:"Release Notes"},sidebar:"tutorialSidebar",previous:{title:"Troubleshooting & FAQ",permalink:"/docs/writing-sample/faqs"}},l={},c=[{value:"Project: Mindee Invoice OCR release notes",id:"project-mindee-invoice-ocr-release-notes",level:3},{value:"Release Note Writing Sample Docs",id:"release-note-writing-sample-docs",level:2}],p={toc:c},u="wrapper";function m(e){let{components:t,...r}=e;return(0,o.kt)(u,(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"welcome-to-my-release-note-writing-portfolio-section"},"Welcome to my Release Note Writing Portfolio Section"),(0,o.kt)("p",null,"As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users. "),(0,o.kt)("h3",{id:"project-mindee-invoice-ocr-release-notes"},"Project: Mindee Invoice OCR release notes"),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"Description:")," Crafted comprehensive release notes to accompany the launch of WidgetPro Version 2.0, a significant update to our versatile widget creation tool."),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"Role:")," Lead Technical Writer"),(0,o.kt)("p",null,(0,o.kt)("strong",{parentName:"p"},"Approach:")," My approach prioritizes clarity and conciseness in presenting complex technical changes, ensuring that users and stakeholders understand the impact of each update."),(0,o.kt)("h2",{id:"release-note-writing-sample-docs"},"Release Note Writing Sample Docs"),(0,o.kt)("iframe",{width:"100%",height:"800",src:"/img/pdf/release.pdf"}),(0,o.kt)("p",null,"If you're interested in collaborating on similar projects or require more information, please ",(0,o.kt)("a",{parentName:"p",href:"mailto:favourkelvin17@gmail.com"},"reach out"),". I'm enthusiastic about discussing how I can contribute to creating informative and engaging release notes for your products!"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/8d7b424f.caec00b9.js b/assets/js/8d7b424f.caec00b9.js deleted file mode 100644 index 7564b205..00000000 --- a/assets/js/8d7b424f.caec00b9.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[6368],{3905:(e,t,r)=>{r.d(t,{Zo:()=>c,kt:()=>g});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var s=n.createContext({}),p=function(e){var t=n.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(r),d=a,g=u["".concat(s,".").concat(d)]||u[d]||m[d]||o;return r?n.createElement(g,i(i({ref:t},c),{},{components:r})):n.createElement(g,i({ref:t},c))}));function g(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:a,i[1]=l;for(var p=2;p{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var n=r(7462),a=(r(7294),r(3905));const o={sidebar_position:8,sidebar_label:"Release Notes"},i="Welcome to my Release Note Writing Portfolio Section",l={unversionedId:"writing-sample/release-notes",id:"writing-sample/release-notes",title:"Welcome to my Release Note Writing Portfolio Section",description:"Greetings! As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users. Below, you will find an illustrative example of my proficiency in this specialized field:",source:"@site/docs/writing-sample/release-notes.md",sourceDirName:"writing-sample",slug:"/writing-sample/release-notes",permalink:"/docs/writing-sample/release-notes",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/writing-sample/release-notes.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8,sidebar_label:"Release Notes"},sidebar:"tutorialSidebar",previous:{title:"Troubleshooting & FAQ",permalink:"/docs/writing-sample/faqs"}},s={},p=[{value:"Project: Launching WidgetPro Version 2.0",id:"project-launching-widgetpro-version-20",level:3},{value:"Release Note Writing Sample Docs",id:"release-note-writing-sample-docs",level:2}],c={toc:p},u="wrapper";function m(e){let{components:t,...r}=e;return(0,a.kt)(u,(0,n.Z)({},c,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"welcome-to-my-release-note-writing-portfolio-section"},"Welcome to my Release Note Writing Portfolio Section"),(0,a.kt)("p",null,"Greetings! As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users. Below, you will find an illustrative example of my proficiency in this specialized field:"),(0,a.kt)("h3",{id:"project-launching-widgetpro-version-20"},"Project: Launching WidgetPro Version 2.0"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Description:")," Crafted comprehensive release notes to accompany the launch of WidgetPro Version 2.0, a significant update to our versatile widget creation tool."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Role:")," Lead Technical Writer"),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Approach:")," My approach prioritizes clarity and conciseness in presenting complex technical changes, ensuring that users and stakeholders understand the impact of each update."),(0,a.kt)("p",null,(0,a.kt)("strong",{parentName:"p"},"Key Sections:")),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},"Introduction to WidgetPro 2.0:")),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Provided a brief overview of the WidgetPro software and highlighted the significance of the 2.0 update."))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},"Release Highlights:")),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Listed and summarized the key features and improvements brought by Version 2.0."))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},"Detailed Changes:")),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Presented an in-depth breakdown of technical changes, bug fixes, and performance enhancements."))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},"Known Issues and Workarounds:")),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Transparently acknowledged any known issues and provided solutions or workarounds where applicable."))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},"Upcoming Features Preview:")),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Gave users a sneak peek into upcoming features and improvements on the product roadmap."))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},"Feedback and Support:")),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Encouraged users to share their feedback, report issues, and offered avenues for customer support."))),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("p",{parentName:"li"},(0,a.kt)("strong",{parentName:"p"},"Conclusion:")),(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Summarized the significance of the update and expressed gratitude for user support and feedback.")))),(0,a.kt)("h2",{id:"release-note-writing-sample-docs"},"Release Note Writing Sample Docs"),(0,a.kt)("iframe",{width:"100%",height:"800",src:"/img/pdf/release"}),(0,a.kt)("p",null,"If you're interested in collaborating on similar projects or require more information, please ",(0,a.kt)("a",{parentName:"p",href:"mailto:favourkelvin17@gmail.com"},"reach out"),". I'm enthusiastic about discussing how I can contribute to creating informative and engaging release notes for your products!"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.a069ca25.js b/assets/js/935f2afb.f568945b.js similarity index 79% rename from assets/js/935f2afb.a069ca25.js rename to assets/js/935f2afb.f568945b.js index 2b90180d..f6cb3ad2 100644 --- a/assets/js/935f2afb.a069ca25.js +++ b/assets/js/935f2afb.f568945b.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"About Me","href":"/docs/intro","docId":"intro"},{"type":"link","label":"Work Experience","href":"/docs/new","docId":"new"},{"type":"category","label":"Writing Samples","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"User Manuals and Guides","href":"/docs/writing-sample/user-manual","docId":"writing-sample/user-manual"},{"type":"link","label":"Tutorials","href":"/docs/writing-sample/tutorial","docId":"writing-sample/tutorial"},{"type":"link","label":"How-to Guides","href":"/docs/writing-sample/how-to-guide","docId":"writing-sample/how-to-guide"},{"type":"link","label":"Blogs and Articles","href":"/docs/writing-sample/blogs","docId":"writing-sample/blogs"},{"type":"link","label":"API Documentation","href":"/docs/writing-sample/api","docId":"writing-sample/api"},{"type":"link","label":"Newsletter Writing","href":"/docs/writing-sample/newsletter","docId":"writing-sample/newsletter"},{"type":"link","label":"Troubleshooting & FAQ","href":"/docs/writing-sample/faqs","docId":"writing-sample/faqs"},{"type":"link","label":"Release Notes","href":"/docs/writing-sample/release-notes","docId":"writing-sample/release-notes"}],"href":"/docs/category/writing-samples"}]},"docs":{"intro":{"id":"intro","title":"Welcome to Favour Kelvin\'s Portfolio","description":"Hello! I\'m Favour Kelvin, and I\'m thrilled to share a glimpse of my journey with you \ud83d\ude03. I am a Technical Writer with a strong background in Software Engineering. My career began as a software developer, where I discovered my passion for open-source projects. I have had the privilege of participating in three Google Open Source programs: Google Summer of Code, Google Code-In, and Google Season of Docs.","sidebar":"tutorialSidebar"},"new":{"id":"new","title":"Experience","description":"Download my resume for a PDF version of this information.","sidebar":"tutorialSidebar"},"writing-sample/api":{"id":"writing-sample/api","title":"API Documentation","description":"Welcome to the API Documentation section of my portfolio! As a dedicated technical writer, I excel in creating clear, detailed, and user-friendly API documentation that facilitates seamless integration and interaction with software systems. Below, you\'ll find a sample of my work in this realm:","sidebar":"tutorialSidebar"},"writing-sample/blogs":{"id":"writing-sample/blogs","title":"Blogs and Articles Writing Sample","description":"Welcome to my Blogs and Articles writing sample section! As a proficient writer, I enjoy creating engaging and informative blog posts and articles on a wide range of topics. Below are some examples of my work in this domain:","sidebar":"tutorialSidebar"},"writing-sample/faqs":{"id":"writing-sample/faqs","title":"Troubleshooting and FAQ Writing Portfolio Sample","description":"Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:","sidebar":"tutorialSidebar"},"writing-sample/how-to-guide":{"id":"writing-sample/how-to-guide","title":"How-to Guide Documentation Sample","description":"Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:","sidebar":"tutorialSidebar"},"writing-sample/newsletter":{"id":"writing-sample/newsletter","title":"Welcome to my Newsletter Writing Portfolio","description":"Welcome to my Newsletter Writing portfolio section! As a technical writer with a knack for effective communication, I specialize in crafting engaging and informative newsletters that captivate your audience. Below is an example of my work in this category:","sidebar":"tutorialSidebar"},"writing-sample/release-notes":{"id":"writing-sample/release-notes","title":"Welcome to my Release Note Writing Portfolio Section","description":"Greetings! As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users. Below, you will find an illustrative example of my proficiency in this specialized field:","sidebar":"tutorialSidebar"},"writing-sample/tutorial":{"id":"writing-sample/tutorial","title":"Tutorials Sample","description":"Welcome to my Tutorials portfolio section! As a technical writer, I specialize in creating comprehensive and easy-to-follow tutorials that guide users through complex processes step by step. Below, you\'ll find an example of my work in this domain:","sidebar":"tutorialSidebar"},"writing-sample/user-manual":{"id":"writing-sample/user-manual","title":"User Manuals and Guides","description":"Welcome to my User Manuals and Guides portfolio section! As a technical writer, I specialize in crafting clear and comprehensive user documentation that helps users navigate and utilize products effectively. Below are some examples of my work in this domain:","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[53],{1109:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"tutorialSidebar":[{"type":"link","label":"About Me","href":"/docs/intro","docId":"intro"},{"type":"link","label":"Work Experience","href":"/docs/new","docId":"new"},{"type":"category","label":"Writing Samples","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"User Manuals and Guides","href":"/docs/writing-sample/user-manual","docId":"writing-sample/user-manual"},{"type":"link","label":"Tutorials","href":"/docs/writing-sample/tutorial","docId":"writing-sample/tutorial"},{"type":"link","label":"How-to Guides","href":"/docs/writing-sample/how-to-guide","docId":"writing-sample/how-to-guide"},{"type":"link","label":"Blogs and Articles","href":"/docs/writing-sample/blogs","docId":"writing-sample/blogs"},{"type":"link","label":"API Documentation","href":"/docs/writing-sample/api","docId":"writing-sample/api"},{"type":"link","label":"Newsletter Writing","href":"/docs/writing-sample/newsletter","docId":"writing-sample/newsletter"},{"type":"link","label":"Troubleshooting & FAQ","href":"/docs/writing-sample/faqs","docId":"writing-sample/faqs"},{"type":"link","label":"Release Notes","href":"/docs/writing-sample/release-notes","docId":"writing-sample/release-notes"}],"href":"/docs/category/writing-samples"}]},"docs":{"intro":{"id":"intro","title":"Welcome to Favour Kelvin\'s Portfolio","description":"Hello! I\'m Favour Kelvin, and I\'m thrilled to share a glimpse of my journey with you \ud83d\ude03. I am a Technical Writer with a strong background in Software Engineering. My career began as a software developer, where I discovered my passion for open-source projects. I have had the privilege of participating in three Google Open Source programs: Google Summer of Code, Google Code-In, and Google Season of Docs.","sidebar":"tutorialSidebar"},"new":{"id":"new","title":"Experience","description":"Download my resume for a PDF version of this information.","sidebar":"tutorialSidebar"},"writing-sample/api":{"id":"writing-sample/api","title":"API Documentation","description":"Welcome to the API Documentation section of my portfolio! As a dedicated technical writer, I excel in creating clear, detailed, and user-friendly API documentation that facilitates seamless integration and interaction with software systems. Below, you\'ll find a sample of my work in this realm:","sidebar":"tutorialSidebar"},"writing-sample/blogs":{"id":"writing-sample/blogs","title":"Blogs and Articles Writing Sample","description":"Welcome to my Blogs and Articles writing sample section! As a proficient writer, I enjoy creating engaging and informative blog posts and articles on a wide range of topics. Below are some examples of my work in this domain:","sidebar":"tutorialSidebar"},"writing-sample/faqs":{"id":"writing-sample/faqs","title":"Troubleshooting and FAQ Writing Portfolio Sample","description":"Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:","sidebar":"tutorialSidebar"},"writing-sample/how-to-guide":{"id":"writing-sample/how-to-guide","title":"How-to Guide Documentation Sample","description":"Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:","sidebar":"tutorialSidebar"},"writing-sample/newsletter":{"id":"writing-sample/newsletter","title":"Welcome to my Newsletter Writing Portfolio","description":"Welcome to my Newsletter Writing portfolio section! As a technical writer with a knack for effective communication, I specialize in crafting engaging and informative newsletters that captivate your audience. Below is an example of my work in this category:","sidebar":"tutorialSidebar"},"writing-sample/release-notes":{"id":"writing-sample/release-notes","title":"Welcome to my Release Note Writing Portfolio Section","description":"As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users.","sidebar":"tutorialSidebar"},"writing-sample/tutorial":{"id":"writing-sample/tutorial","title":"Tutorials Sample","description":"Welcome to my Tutorials portfolio section! As a technical writer, I specialize in creating comprehensive and easy-to-follow tutorials that guide users through complex processes step by step. Below, you\'ll find an example of my work in this domain:","sidebar":"tutorialSidebar"},"writing-sample/user-manual":{"id":"writing-sample/user-manual","title":"User Manuals and Guides","description":"Welcome to my User Manuals and Guides portfolio section! As a technical writer, I specialize in crafting clear and comprehensive user documentation that helps users navigate and utilize products effectively. Below are some examples of my work in this domain:","sidebar":"tutorialSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/c335d7b4.47080be1.js b/assets/js/c335d7b4.e6f7d1c9.js similarity index 94% rename from assets/js/c335d7b4.47080be1.js rename to assets/js/c335d7b4.e6f7d1c9.js index 3086f94c..9c4b1926 100644 --- a/assets/js/c335d7b4.47080be1.js +++ b/assets/js/c335d7b4.e6f7d1c9.js @@ -1 +1 @@ -"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8155],{3905:(e,t,a)=>{a.d(t,{Zo:()=>u,kt:()=>g});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),p=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},u=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=p(a),d=n,g=c["".concat(s,".").concat(d)]||c[d]||m[d]||o;return a?r.createElement(g,i(i({ref:t},u),{},{components:a})):r.createElement(g,i({ref:t},u))}));function g(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:n,i[1]=l;for(var p=2;p{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=a(7462),n=(a(7294),a(3905));const o={sidebar_position:8,sidebar_label:"Troubleshooting & FAQ"},i="Troubleshooting and FAQ Writing Portfolio Sample",l={unversionedId:"writing-sample/faqs",id:"writing-sample/faqs",title:"Troubleshooting and FAQ Writing Portfolio Sample",description:"Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:",source:"@site/docs/writing-sample/faqs.md",sourceDirName:"writing-sample",slug:"/writing-sample/faqs",permalink:"/docs/writing-sample/faqs",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/writing-sample/faqs.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8,sidebar_label:"Troubleshooting & FAQ"},sidebar:"tutorialSidebar",previous:{title:"Newsletter Writing",permalink:"/docs/writing-sample/newsletter"},next:{title:"Release Notes",permalink:"/docs/writing-sample/release-notes"}},s={},p=[{value:"Project: Bacalhau FAQs",id:"project-bacalhau-faqs",level:3},{value:"Troubleshooting & FAQ Writing sample docs",id:"troubleshooting--faq-writing-sample-docs",level:2}],u={toc:p},c="wrapper";function m(e){let{components:t,...a}=e;return(0,n.kt)(c,(0,r.Z)({},u,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"troubleshooting-and-faq-writing-portfolio-sample"},"Troubleshooting and FAQ Writing Portfolio Sample"),(0,n.kt)("p",null,"Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:"),(0,n.kt)("h3",{id:"project-bacalhau-faqs"},"Project: Bacalhau FAQs"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Description:")," Developed detailed troubleshooting and frequently asked questions (FAQ) documentation for Bacalhau, a versatile computing platform, to assist users in resolving common problems and queries."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Role:")," Lead Technical Writer"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Approach:")," My approach prioritized user-centricity, aiming to simplify complex technical issues and provide step-by-step solutions that users of all levels could follow effortlessly."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Key Sections:")),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I use multiple data sources in the same job?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Answered how users can utilize multiple data sources in a Bacalhau job."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How can I submit Job requests through CLI to communicate with my Node directly?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Provided instructions on configuring CLI to communicate directly with Bacalhau nodes."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Why does my API server listen on /ip4/127.0.0.1/tcp/5001 when I invoke IPFS Daemon when fetching an IPFS Multiaddress?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Explained the reasons for this behavior and how to address it."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"What to do when I get error connection refused when running Bacalhau API?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Offered troubleshooting steps for resolving connection issues with Bacalhau API."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I run Bacalhau in a containerized setup (nested containers)?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Addressed the feasibility of running Bacalhau in a containerized setup."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I run non-Docker jobs?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Explained the possibility of running non-Docker jobs using WebAssembly."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How do I run a script that requires installing packages from a package repository like pypi or apt?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Provided guidance on running scripts with external package dependencies."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How do I see a job\u2019s progress while it\u2019s running?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Clarified the current limitations regarding job progress tracking."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How do I get an IPFS peer if I want to start Bacalhau Server?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Explained how to obtain an IPFS peer for Bacalhau Server."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How can I download and query SQLite when it complains about being in a read-only directory?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Provided a solution for running SQLite in a read-only directory."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I run Bacalhau serve on my home machine? What are the requirements?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Clarified the system requirements for running Bacalhau serve."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I stop a running job?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Informed users about the process of stopping a running Bacalhau job.")))),(0,n.kt)("h2",{id:"troubleshooting--faq-writing-sample-docs"},"Troubleshooting & FAQ Writing sample docs"),(0,n.kt)("iframe",{width:"100%",height:"800",src:"/img/pdf/faq"}),(0,n.kt)("p",null,"If you're interested in collaborating on similar projects or would like more details, please don't hesitate to ",(0,n.kt)("a",{parentName:"p",href:"mailto:favourkelvin17@gmail.com"},"contact me"),". I'm enthusiastic about helping you create effective troubleshooting guides and FAQs for your products!"),(0,n.kt)("p",null,"You can expect the same level of professionalism and user-focused approach in all my troubleshooting and FAQ writing projects."))}m.isMDXComponent=!0}}]); \ No newline at end of file +"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[8155],{3905:(e,t,a)=>{a.d(t,{Zo:()=>u,kt:()=>g});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var s=r.createContext({}),p=function(e){var t=r.useContext(s),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},u=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),c=p(a),d=n,g=c["".concat(s,".").concat(d)]||c[d]||m[d]||o;return a?r.createElement(g,i(i({ref:t},u),{},{components:a})):r.createElement(g,i({ref:t},u))}));function g(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=d;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:n,i[1]=l;for(var p=2;p{a.r(t),a.d(t,{assets:()=>s,contentTitle:()=>i,default:()=>m,frontMatter:()=>o,metadata:()=>l,toc:()=>p});var r=a(7462),n=(a(7294),a(3905));const o={sidebar_position:8,sidebar_label:"Troubleshooting & FAQ"},i="Troubleshooting and FAQ Writing Portfolio Sample",l={unversionedId:"writing-sample/faqs",id:"writing-sample/faqs",title:"Troubleshooting and FAQ Writing Portfolio Sample",description:"Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:",source:"@site/docs/writing-sample/faqs.md",sourceDirName:"writing-sample",slug:"/writing-sample/faqs",permalink:"/docs/writing-sample/faqs",draft:!1,editUrl:"https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/docs/writing-sample/faqs.md",tags:[],version:"current",sidebarPosition:8,frontMatter:{sidebar_position:8,sidebar_label:"Troubleshooting & FAQ"},sidebar:"tutorialSidebar",previous:{title:"Newsletter Writing",permalink:"/docs/writing-sample/newsletter"},next:{title:"Release Notes",permalink:"/docs/writing-sample/release-notes"}},s={},p=[{value:"Project: Bacalhau FAQs",id:"project-bacalhau-faqs",level:3},{value:"Troubleshooting & FAQ Writing sample docs",id:"troubleshooting--faq-writing-sample-docs",level:2}],u={toc:p},c="wrapper";function m(e){let{components:t,...a}=e;return(0,n.kt)(c,(0,r.Z)({},u,a,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"troubleshooting-and-faq-writing-portfolio-sample"},"Troubleshooting and FAQ Writing Portfolio Sample"),(0,n.kt)("p",null,"Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:"),(0,n.kt)("h3",{id:"project-bacalhau-faqs"},"Project: Bacalhau FAQs"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Description:")," Developed detailed troubleshooting and frequently asked questions (FAQ) documentation for Bacalhau, a versatile computing platform, to assist users in resolving common problems and queries."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Role:")," Lead Technical Writer"),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Approach:")," My approach prioritized user-centricity, aiming to simplify complex technical issues and provide step-by-step solutions that users of all levels could follow effortlessly."),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Key Sections:")),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I use multiple data sources in the same job?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Answered how users can utilize multiple data sources in a Bacalhau job."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How can I submit Job requests through CLI to communicate with my Node directly?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Provided instructions on configuring CLI to communicate directly with Bacalhau nodes."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Why does my API server listen on /ip4/127.0.0.1/tcp/5001 when I invoke IPFS Daemon when fetching an IPFS Multiaddress?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Explained the reasons for this behavior and how to address it."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"What to do when I get error connection refused when running Bacalhau API?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Offered troubleshooting steps for resolving connection issues with Bacalhau API."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I run Bacalhau in a containerized setup (nested containers)?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Addressed the feasibility of running Bacalhau in a containerized setup."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I run non-Docker jobs?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Explained the possibility of running non-Docker jobs using WebAssembly."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How do I run a script that requires installing packages from a package repository like pypi or apt?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Provided guidance on running scripts with external package dependencies."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How do I see a job\u2019s progress while it\u2019s running?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Clarified the current limitations regarding job progress tracking."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How do I get an IPFS peer if I want to start Bacalhau Server?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Explained how to obtain an IPFS peer for Bacalhau Server."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"How can I download and query SQLite when it complains about being in a read-only directory?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Provided a solution for running SQLite in a read-only directory."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I run Bacalhau serve on my home machine? What are the requirements?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Clarified the system requirements for running Bacalhau serve."))),(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("p",{parentName:"li"},(0,n.kt)("strong",{parentName:"p"},"Can I stop a running job?")),(0,n.kt)("ul",{parentName:"li"},(0,n.kt)("li",{parentName:"ul"},"Informed users about the process of stopping a running Bacalhau job.")))),(0,n.kt)("h2",{id:"troubleshooting--faq-writing-sample-docs"},"Troubleshooting & FAQ Writing sample docs"),(0,n.kt)("iframe",{width:"100%",height:"800",src:"/img/pdf/faq.pdf"}),(0,n.kt)("p",null,"If you're interested in collaborating on similar projects or would like more details, please don't hesitate to ",(0,n.kt)("a",{parentName:"p",href:"mailto:favourkelvin17@gmail.com"},"contact me"),". I'm enthusiastic about helping you create effective troubleshooting guides and FAQs for your products!"),(0,n.kt)("p",null,"You can expect the same level of professionalism and user-focused approach in all my troubleshooting and FAQ writing projects."))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.1c882dd9.js b/assets/js/runtime~main.1c882dd9.js new file mode 100644 index 00000000..903a9255 --- /dev/null +++ b/assets/js/runtime~main.1c882dd9.js @@ -0,0 +1 @@ +(()=>{"use strict";var e,t,a,r,f,d={},c={};function o(e){var t=c[e];if(void 0!==t)return t.exports;var a=c[e]={id:e,loaded:!1,exports:{}};return d[e].call(a.exports,a,a.exports,o),a.loaded=!0,a.exports}o.m=d,o.c=c,e=[],o.O=(t,a,r,f)=>{if(!a){var d=1/0;for(i=0;i=f)&&Object.keys(o.O).every((e=>o.O[e](a[b])))?a.splice(b--,1):(c=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[a,r,f]},o.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return o.d(t,{a:t}),t},a=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);o.r(f);var d={};t=t||[null,a({}),a([]),a(a)];for(var c=2&r&&e;"object"==typeof c&&!~t.indexOf(c);c=a(c))Object.getOwnPropertyNames(c).forEach((t=>d[t]=()=>e[t]));return d.default=()=>e,o.d(f,d),f},o.d=(e,t)=>{for(var a in t)o.o(t,a)&&!o.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:t[a]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((t,a)=>(o.f[a](e,t),t)),[])),o.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",453:"30a24c52",533:"b2b675dd",948:"8717b14a",1138:"e2738d97",1477:"b2f554cd",1633:"031793e1",1713:"a7023ddc",1914:"d9f32620",2267:"59362658",2362:"e273c56f",2535:"814f3328",2543:"0c93a30d",3085:"1f391b9e",3089:"a6aa9e1f",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3651:"f67444f6",3877:"34914372",4013:"01a85c17",4195:"c4f5d8e4",4256:"a3d44c41",5233:"2779d0de",6103:"ccc49370",6368:"8d7b424f",6938:"608ae6a4",7178:"096bfee4",7298:"84a5f2d1",7414:"393be207",7918:"17896441",8155:"c335d7b4",8168:"e564b77f",8610:"6875c492",8636:"f4f34a3a",8942:"e72e0deb",9003:"925b3f96",9035:"4c9e35b1",9060:"2e9ce459",9514:"1be78505",9581:"8e1485df",9642:"7661071f",9671:"0e384e19",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"f568945b",110:"8dcbcfde",453:"9ed5bd5c",533:"d838adc3",948:"951a963a",1138:"5876d95f",1477:"ac6d2a04",1506:"2e7ca40e",1633:"ed2d5306",1713:"94ca480e",1914:"41c29c6e",2267:"5f9f9b60",2362:"d4629666",2529:"acc6a5c9",2535:"f1eafc3d",2543:"8bcb865f",3085:"85cb589c",3089:"49fdb278",3205:"80cfa478",3514:"a7c8ef71",3608:"a9bd7bfc",3651:"c6d0e451",3877:"eff13be1",4013:"92faa9e9",4195:"1a86edad",4256:"76c8a787",4972:"42a6d37d",5233:"0c3af32d",6103:"7b4517fe",6368:"a0a67a4f",6938:"54822b6c",7178:"3f3fee8a",7298:"7f8f3e42",7414:"3e30333d",7918:"156a7a8e",8155:"e6f7d1c9",8168:"c00eb439",8610:"850658b3",8636:"5da970f4",8942:"eabdc373",9003:"f7a679a2",9035:"af2ca165",9060:"8c747051",9514:"20714371",9581:"2ab120b0",9642:"28fc85eb",9671:"3b6452d4",9700:"5e1b3f1e",9817:"06b33357"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r={},f="my-website:",o.l=(e,t,a,d)=>{if(r[e])r[e].push(t);else{var c,b;if(void 0!==a)for(var n=document.getElementsByTagName("script"),i=0;i{c.onerror=c.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],c.parentNode&&c.parentNode.removeChild(c),f&&f.forEach((e=>e(a))),t)return t(a)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:c}),12e4);c.onerror=l.bind(null,c.onerror),c.onload=l.bind(null,c.onload),b&&document.head.appendChild(c)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.p="/",o.gca=function(e){return e={17896441:"7918",34914372:"3877",59362658:"2267",66406991:"110","935f2afb":"53","30a24c52":"453",b2b675dd:"533","8717b14a":"948",e2738d97:"1138",b2f554cd:"1477","031793e1":"1633",a7023ddc:"1713",d9f32620:"1914",e273c56f:"2362","814f3328":"2535","0c93a30d":"2543","1f391b9e":"3085",a6aa9e1f:"3089",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",f67444f6:"3651","01a85c17":"4013",c4f5d8e4:"4195",a3d44c41:"4256","2779d0de":"5233",ccc49370:"6103","8d7b424f":"6368","608ae6a4":"6938","096bfee4":"7178","84a5f2d1":"7298","393be207":"7414",c335d7b4:"8155",e564b77f:"8168","6875c492":"8610",f4f34a3a:"8636",e72e0deb:"8942","925b3f96":"9003","4c9e35b1":"9035","2e9ce459":"9060","1be78505":"9514","8e1485df":"9581","7661071f":"9642","0e384e19":"9671",e16015ca:"9700","14eb3368":"9817"}[e]||e,o.p+o.u(e)},(()=>{var e={1303:0,532:0};o.f.j=(t,a)=>{var r=o.o(e,t)?e[t]:void 0;if(0!==r)if(r)a.push(r[2]);else if(/^(1303|532)$/.test(t))e[t]=0;else{var f=new Promise(((a,f)=>r=e[t]=[a,f]));a.push(r[2]=f);var d=o.p+o.u(t),c=new Error;o.l(d,(a=>{if(o.o(e,t)&&(0!==(r=e[t])&&(e[t]=void 0),r)){var f=a&&("load"===a.type?"missing":a.type),d=a&&a.target&&a.target.src;c.message="Loading chunk "+t+" failed.\n("+f+": "+d+")",c.name="ChunkLoadError",c.type=f,c.request=d,r[1](c)}}),"chunk-"+t,t)}},o.O.j=t=>0===e[t];var t=(t,a)=>{var r,f,d=a[0],c=a[1],b=a[2],n=0;if(d.some((t=>0!==e[t]))){for(r in c)o.o(c,r)&&(o.m[r]=c[r]);if(b)var i=b(o)}for(t&&t(a);n{"use strict";var e,a,t,r,f,c={},d={};function o(e){var a=d[e];if(void 0!==a)return a.exports;var t=d[e]={id:e,loaded:!1,exports:{}};return c[e].call(t.exports,t,t.exports,o),t.loaded=!0,t.exports}o.m=c,o.c=d,e=[],o.O=(a,t,r,f)=>{if(!t){var c=1/0;for(i=0;i=f)&&Object.keys(o.O).every((e=>o.O[e](t[b])))?t.splice(b--,1):(d=!1,f0&&e[i-1][2]>f;i--)e[i]=e[i-1];e[i]=[t,r,f]},o.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return o.d(a,{a:a}),a},t=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,o.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);o.r(f);var c={};a=a||[null,t({}),t([]),t(t)];for(var d=2&r&&e;"object"==typeof d&&!~a.indexOf(d);d=t(d))Object.getOwnPropertyNames(d).forEach((a=>c[a]=()=>e[a]));return c.default=()=>e,o.d(f,c),f},o.d=(e,a)=>{for(var t in a)o.o(a,t)&&!o.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:a[t]})},o.f={},o.e=e=>Promise.all(Object.keys(o.f).reduce(((a,t)=>(o.f[t](e,a),a)),[])),o.u=e=>"assets/js/"+({53:"935f2afb",110:"66406991",453:"30a24c52",533:"b2b675dd",948:"8717b14a",1138:"e2738d97",1477:"b2f554cd",1633:"031793e1",1713:"a7023ddc",1914:"d9f32620",2267:"59362658",2362:"e273c56f",2535:"814f3328",2543:"0c93a30d",3085:"1f391b9e",3089:"a6aa9e1f",3205:"a80da1cf",3514:"73664a40",3608:"9e4087bc",3651:"f67444f6",3877:"34914372",4013:"01a85c17",4195:"c4f5d8e4",4256:"a3d44c41",5233:"2779d0de",6103:"ccc49370",6368:"8d7b424f",6938:"608ae6a4",7178:"096bfee4",7298:"84a5f2d1",7414:"393be207",7918:"17896441",8155:"c335d7b4",8168:"e564b77f",8610:"6875c492",8636:"f4f34a3a",8942:"e72e0deb",9003:"925b3f96",9035:"4c9e35b1",9060:"2e9ce459",9514:"1be78505",9581:"8e1485df",9642:"7661071f",9671:"0e384e19",9700:"e16015ca",9817:"14eb3368"}[e]||e)+"."+{53:"a069ca25",110:"8dcbcfde",453:"9ed5bd5c",533:"d838adc3",948:"951a963a",1138:"5876d95f",1477:"ac6d2a04",1506:"2e7ca40e",1633:"ed2d5306",1713:"94ca480e",1914:"41c29c6e",2267:"5f9f9b60",2362:"d4629666",2529:"acc6a5c9",2535:"f1eafc3d",2543:"8bcb865f",3085:"85cb589c",3089:"49fdb278",3205:"80cfa478",3514:"a7c8ef71",3608:"a9bd7bfc",3651:"c6d0e451",3877:"9993729f",4013:"92faa9e9",4195:"1a86edad",4256:"76c8a787",4972:"42a6d37d",5233:"0c3af32d",6103:"7b4517fe",6368:"caec00b9",6938:"54822b6c",7178:"3f3fee8a",7298:"7f8f3e42",7414:"3e30333d",7918:"156a7a8e",8155:"47080be1",8168:"c00eb439",8610:"850658b3",8636:"5da970f4",8942:"eabdc373",9003:"f7a679a2",9035:"af2ca165",9060:"8c747051",9514:"20714371",9581:"2ab120b0",9642:"28fc85eb",9671:"3b6452d4",9700:"5e1b3f1e",9817:"06b33357"}[e]+".js",o.miniCssF=e=>{},o.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),o.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),r={},f="my-website:",o.l=(e,a,t,c)=>{if(r[e])r[e].push(a);else{var d,b;if(void 0!==t)for(var n=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var f=r[e];if(delete r[e],d.parentNode&&d.parentNode.removeChild(d),f&&f.forEach((e=>e(t))),a)return a(t)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),b&&document.head.appendChild(d)}},o.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},o.p="/",o.gca=function(e){return e={17896441:"7918",34914372:"3877",59362658:"2267",66406991:"110","935f2afb":"53","30a24c52":"453",b2b675dd:"533","8717b14a":"948",e2738d97:"1138",b2f554cd:"1477","031793e1":"1633",a7023ddc:"1713",d9f32620:"1914",e273c56f:"2362","814f3328":"2535","0c93a30d":"2543","1f391b9e":"3085",a6aa9e1f:"3089",a80da1cf:"3205","73664a40":"3514","9e4087bc":"3608",f67444f6:"3651","01a85c17":"4013",c4f5d8e4:"4195",a3d44c41:"4256","2779d0de":"5233",ccc49370:"6103","8d7b424f":"6368","608ae6a4":"6938","096bfee4":"7178","84a5f2d1":"7298","393be207":"7414",c335d7b4:"8155",e564b77f:"8168","6875c492":"8610",f4f34a3a:"8636",e72e0deb:"8942","925b3f96":"9003","4c9e35b1":"9035","2e9ce459":"9060","1be78505":"9514","8e1485df":"9581","7661071f":"9642","0e384e19":"9671",e16015ca:"9700","14eb3368":"9817"}[e]||e,o.p+o.u(e)},(()=>{var e={1303:0,532:0};o.f.j=(a,t)=>{var r=o.o(e,a)?e[a]:void 0;if(0!==r)if(r)t.push(r[2]);else if(/^(1303|532)$/.test(a))e[a]=0;else{var f=new Promise(((t,f)=>r=e[a]=[t,f]));t.push(r[2]=f);var c=o.p+o.u(a),d=new Error;o.l(c,(t=>{if(o.o(e,a)&&(0!==(r=e[a])&&(e[a]=void 0),r)){var f=t&&("load"===t.type?"missing":t.type),c=t&&t.target&&t.target.src;d.message="Loading chunk "+a+" failed.\n("+f+": "+c+")",d.name="ChunkLoadError",d.type=f,d.request=c,r[1](d)}}),"chunk-"+a,a)}},o.O.j=a=>0===e[a];var a=(a,t)=>{var r,f,c=t[0],d=t[1],b=t[2],n=0;if(c.some((a=>0!==e[a]))){for(r in d)o.o(d,r)&&(o.m[r]=d[r]);if(b)var i=b(o)}for(a&&a(t);n Archive | Hi, I am Favour Kelvin - +

Archive

Archive

2019

2021

- + \ No newline at end of file diff --git a/blog/first-blog-post/index.html b/blog/first-blog-post/index.html index 4c8f6ed0..7cd02041 100644 --- a/blog/first-blog-post/index.html +++ b/blog/first-blog-post/index.html @@ -5,13 +5,13 @@ First Blog Post | Hi, I am Favour Kelvin - +

First Blog Post

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index 746062e2..60bcc07a 100644 --- a/blog/index.html +++ b/blog/index.html @@ -5,13 +5,13 @@ Blog | Hi, I am Favour Kelvin - +

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/long-blog-post/index.html b/blog/long-blog-post/index.html index 9e3be140..6a5d9680 100644 --- a/blog/long-blog-post/index.html +++ b/blog/long-blog-post/index.html @@ -5,13 +5,13 @@ Long Blog Post | Hi, I am Favour Kelvin - +

Long Blog Post

· 3 min read
Endilie Yacop Sucipto

This is the summary of a very long blog post,

Use a <!-- truncate --> comment to limit blog post size in the list view.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html index 208c2b13..28bef22b 100644 --- a/blog/mdx-blog-post/index.html +++ b/blog/mdx-blog-post/index.html @@ -5,13 +5,13 @@ MDX Blog Post | Hi, I am Favour Kelvin - +
- + \ No newline at end of file diff --git a/blog/tags/docusaurus/index.html b/blog/tags/docusaurus/index.html index acff7ae7..067c6dc7 100644 --- a/blog/tags/docusaurus/index.html +++ b/blog/tags/docusaurus/index.html @@ -5,13 +5,13 @@ 4 posts tagged with "docusaurus" | Hi, I am Favour Kelvin - +

4 posts tagged with "docusaurus"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/tags/facebook/index.html b/blog/tags/facebook/index.html index 7cf917e2..02c75af8 100644 --- a/blog/tags/facebook/index.html +++ b/blog/tags/facebook/index.html @@ -5,13 +5,13 @@ One post tagged with "facebook" | Hi, I am Favour Kelvin - +

One post tagged with "facebook"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/blog/tags/hello/index.html b/blog/tags/hello/index.html index b6e8ee43..24aebc72 100644 --- a/blog/tags/hello/index.html +++ b/blog/tags/hello/index.html @@ -5,13 +5,13 @@ 2 posts tagged with "hello" | Hi, I am Favour Kelvin - +

2 posts tagged with "hello"

View All Tags

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/blog/tags/hola/index.html b/blog/tags/hola/index.html index d5cc35b4..f6a13285 100644 --- a/blog/tags/hola/index.html +++ b/blog/tags/hola/index.html @@ -5,13 +5,13 @@ One post tagged with "hola" | Hi, I am Favour Kelvin - +

One post tagged with "hola"

View All Tags

· One min read
Gao Wei

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet

- + \ No newline at end of file diff --git a/blog/tags/index.html b/blog/tags/index.html index e8520f04..214025e6 100644 --- a/blog/tags/index.html +++ b/blog/tags/index.html @@ -5,13 +5,13 @@ Tags | Hi, I am Favour Kelvin - +

Tags

- + \ No newline at end of file diff --git a/blog/welcome/index.html b/blog/welcome/index.html index df842c05..4f1d5c45 100644 --- a/blog/welcome/index.html +++ b/blog/welcome/index.html @@ -5,13 +5,13 @@ Welcome | Hi, I am Favour Kelvin - +

Welcome

· One min read
Sébastien Lorber
Yangshun Tay

Docusaurus blogging features are powered by the blog plugin.

Simply add Markdown files (or folders) to the blog directory.

Regular blog authors can be added to authors.yml.

The blog post date can be extracted from filenames, such as:

  • 2019-05-30-welcome.md
  • 2019-05-30-welcome/index.md

A blog post folder can be convenient to co-locate blog post images:

Docusaurus Plushie

The blog supports tags as well!

And if you don't want a blog: just delete this directory, and use blog: false in your Docusaurus config.

- + \ No newline at end of file diff --git a/docs/category/writing-samples/index.html b/docs/category/writing-samples/index.html index 03dc2cef..8a7b2414 100644 --- a/docs/category/writing-samples/index.html +++ b/docs/category/writing-samples/index.html @@ -5,13 +5,13 @@ Writing Samples | Hi, I am Favour Kelvin - +
-

Writing Samples

This section provides examples of my technical writing. I wrote this documentation for product knowledge base, internal engineering teams, and customer-facing, support teams, etc. The pages in each section are not the full documentation for a product or service.

- +

Writing Samples

This section provides examples of my technical writing. I wrote this documentation for product knowledge base, internal engineering teams, and customer-facing, support teams, etc. The pages in each section are not the full documentation for a product or service.

+ \ No newline at end of file diff --git a/docs/intro/index.html b/docs/intro/index.html index f95091db..a43092cb 100644 --- a/docs/intro/index.html +++ b/docs/intro/index.html @@ -5,13 +5,13 @@ Welcome to Favour Kelvin's Portfolio | Hi, I am Favour Kelvin - +

Welcome to Favour Kelvin's Portfolio

Hello! I'm Favour Kelvin, and I'm thrilled to share a glimpse of my journey with you 😃. I am a Technical Writer with a strong background in Software Engineering. My career began as a software developer, where I discovered my passion for open-source projects. I have had the privilege of participating in three Google Open Source programs: Google Summer of Code, Google Code-In, and Google Season of Docs.

I’m very passionate about sharing knowledge, educating people about technology and helping them become better at what they do. do this by writing technical articles, contributing to open-source initiatives, creating documentation, and organizing/speaking at meetups and conferences.

Throughout my professional journey, I have collaborated with diverse individuals, led teams, improved support systems, optimized operations, managed information systems, communities, etc.

As a Technical Writer, I have dedicated years to working with exceptional teams and producing clear and comprehensive technical content, including documentation, user guides, and blogs. My areas of expertise span from DevOps and Cloud Computing to Web Development, IoT, Data Science, Web3, Data Automation, Database Management, and more.

Notable Achievements​

Here are some highlights from my journey:

  • Authored over 70+ articles within a short span, sharing valuable insights and knowledge with a wide audience.

  • Implemented content calendars and streamlined content creation processes, elevating content quality and publication efficiency.

  • Actively participated in and mentored participants in three prestigious Google Open Source Programs, nurturing the growth of open-source initiatives.

  • Pioneered and scaled documentation from scratch to ensure users have access to clear and comprehensive resources.

  • Elevated the quality of existing content and conducted meticulous documentation audits for organizations, enhancing user experiences.

  • Introduced documentation analytics, leading to a significant increase in user satisfaction by providing valuable insights into user engagement.

  • Established a documentation platform, streamlining the content creation process.

  • Implemented style guides to ensure a consistent voice, tone, and terminology.

  • Collaborated with cross-functional teams to establish a seamless feedback loop for documentation updates, enhancing user satisfaction.

  • Integrated technical writing into the Agile development process of a company, ensuring documentation remains up-to-date with every sprint release.

  • Played a pivotal role in building and nurturing a thriving community of open-source enthusiasts through my involvement with Open Source Community Africa, fostering collaboration and innovation in the open-source world.

Why Choose Me?​

Now, you might be wondering, "Why should I consider Favour Kelvin?" Here are a few compelling reasons:

  • I am committed to delivering my absolute best in every task I undertake.

  • I am passionate about teaching and sharing knowledge, which forms the foundation of my developer relations and education strengths.

  • I can adapt to new conditions, align with company goals and visions, and cater to the evolving needs of your developer product.

  • Honesty is my guiding principle; I'll never oversell your product, but I will diligently convey its strengths and value to developers.

  • I excel at building and leading developer communities, fostering camaraderie and collaboration.

My Key Strengths​

  • Proficient in writing code when necessary using JavaScript, TypeScript, and Python programming languages.

  • Expertise in Web3 content creation.

  • API documentation.

  • Technical content creation.

  • Content production and marketing.

  • Community and programs management.

  • Organizing developer events.

  • Memes collection and efficient distribution :).

What I'll Bring to Your Team​

As your next Technical Writer or Developer Advocate, I will leverage my software engineering and developer relations experience to:

  • Serve as a bridge between your product and developers, helping them succeed with your product offerings.

  • Engage with technical and non-technical customers across different engineering teams to articulate the value of your product.

  • Develop tools, code demos, integrations, content, educational materials, and documentation to empower developers to fully utilize your products.

  • Collaborate with strategic partners to showcase the potential of your product when combined with other tools and services loved by developers.

  • Educate developers about your product through open-source contributions, public speaking, technical workshops at conferences, local developer meetups, documentation, and published tutorials/videos.

  • Led discussions on the latest technological advancements and best practices within and beyond your product's scope in the developer community, through in-person events, online forums, and social media.

  • Cultivate and nurture a thriving community of developers who use your product.

  • Collaborate closely with your engineering, product, marketing, sales, and customer success teams to enhance the developer experience of your product.

  • Test new product features and provide early feedback for continuous improvement.

  • Collect feedback from the developer community on existing and upcoming product features for informed planning, prioritization, and implementation.

  • Monitor and measure the success and impact of the activities and responsibilities entrusted to me, demonstrating the value of Developer Relations at your company.

Companies I Have Worked With​

Here are some of the companies I've had the pleasure of collaborating with, in various capacities, including full-time, part-time, contract, fixed basis, and one-time projects:

  • Protocol Labs: A research, development, and deployment laboratory known for projects like IPFS, Filecoin, and libp2p, aiming to enhance human existence through technology.

  • Calimero: A web3 customizable sidechain built on top of the NEAR protocol.

  • Mindee: An OCR API for developers.

  • Coupler.io: A data analytics and automation platform.

  • Mautic: An open-source marketing automation tool.

  • PeeringDB: A user-maintained database of networks, serving as the go-to resource for interconnection data.

  • GlueOps: A platform that streamlines and maximizes DevOps and DataOps for efficient management and growth.

  • SugarLabs: A community-driven software project focused on producing, distributing, and supporting Sugar, an open-source desktop environment and learning platform.

Let's Connect!​

If you have exciting opportunities or need tech expertise, please reach out. I am open to both full-time positions and short-term contracts that align with my skills and interests. You can contact me via email at [Your Email Address], or connect with me on LinkedIn or Twitter. I'm looking forward to connecting with you! ❤️

- + \ No newline at end of file diff --git a/docs/new/index.html b/docs/new/index.html index e0cd838a..289c3ca4 100644 --- a/docs/new/index.html +++ b/docs/new/index.html @@ -5,13 +5,13 @@ Experience | Hi, I am Favour Kelvin - +

Experience

Download my resume for a PDF version of this information.

Protocol Labs (Bacalhau) — Senior Technical Writer​

Dec. 2022 - Present

  • Position Bacalhau as the leader in serverless computing through storytelling across platforms
  • Devise a plan to document all aspects of Bacalhau, including usage examples, conceptual documentation, and specification writing.
  • Affect the lives of countless people you help bring into this community.
  • Work directly with Software Engineers to understand the abstractions and interfaces that Bacalhau offers to programmers and document them in a way that helps programmers go from zero to expert in a step-by-step fashion.
  • Assist the DevRel team in creating other resources, including blogs, user guides, FAQs, tutorials, and white papers.
  • Edit and review content created by others for technical accuracy and clarity.
  • Proactively identify gaps in the documentation or knowledge base articles.

Mindee — Senior Technical Writer​

Nov. 2021 - Aug. 2022

  • Understood the product space and ensured high levels of accuracy in documentation.
  • Accurately captured all relevant content and resources, establishing visibility for users.
  • Understood the writing style guide and refined it.
  • Performed PR reviews for their peers that considered flow and the audience, as well as the goals of the product.
  • Listened to the priorities and concerns of others, and acknowledged different perspectives.
  • Reflected on user feedback and turned it into something actionable.
  • Participated in meetings, and created cross-team collaboration was necessary to address business goals.

PeeringDB — Technical Writer​

July 2021 - Jan 2022

  • Worked with me on a documentation architecture project for PeeringDB
  • Worked on creating educative articles to help Peering DB users understand the product better
  • Conducted user analysis while creating documentation that describes the documentation needs of PeeringDB users.
  • Mapped out the product features and the different kinds of users who interact with them.
  • Single-handedly created a content documentation structure showing where documentation is needed to empower users to make the best use of the services offered by PeeringDB.
  • Created document templates that can be used by future document authors to create consistently formatted documents.

Mautic— Team Education Lead​

Jan. 2021 - Present (open source)

  • Led a team of technical writers in creating the Mautic user guide
  • Created a content development strategy for the education team
  • Analyzed documentation needs and make recommendations regarding documentation priorities.

DocumentWrite — Technical Writer​

Jun. 2021 - Nov 2021

  • Collaborated with the teams to create a documentation structure and understand user needs
  • Built how-to-guide documentation from the ground up
  • Co-authored the company's first official style guide to maintain a reliable, consistent document lifecycle.
  • Managed and updated the existing document content with current information on releases
  • Worked together with the customer success, marketing, and product management teams to achieve project success.

Extrimian — Technical Writer​

Feb 2021 - May 2021

  • Wrote documentation on blockchain technology and decentralization.
  • Developed the company's first official technical documentation in an agile environment while meeting 100% of the team deadline
  • Worked with the developers, designers and marketing team to create documentation from the ground up

Google Season of Docs — Technical Writer​

Aug. 2020 - Dec. 2020

  • Wrote technical related articles for Mautic Knowledge Base during the Google season of Docs program
  • Wrote API and reference documentation for developers.
  • Created user guides and tutorials to enable users to get started with Mautic

Open Source Community Africa — Volunteer​

May 2018 - Present (open source)

  • Worked with a team of designers and developers to build the official organization website
  • Ensured compatibility by cross-testing in various browsers and platforms
  • Worked with a variety of different frameworks, languages javascript, React, Gatsby, Html, CSS, etc
  • Assisted in community building and organizing meetups with other teammates to enable the community to know more about open source.

Google Code-In|Sugarlabs — Mentor​

Dec 2019 - Jan 2020

  • Worked with a team of developers in setting out tasks and providing guidance to students through code reviews and constructive feedback.
  • Collaborated with other developers and the community to facilitate the acceptance of students' work.
  • Worked in collaboration with the student contributors in adding features that have improved the app and users' experience by 100%.

Google Summer Of Code|Sugarlabs — Software Developer​

May 2019 - Aug. 2019

  • Implemented the use of continuous integration and deployment using Travis CI
  • Worked closely with mentors and other developers in developing and writing modern, performant, and robust code for the project which helped to increase the app performance and users' experience tremendously
  • Added some major features to the applications, such as the use of service worker, a bundler(webpack, gulp) which increased the performance of the app by 90%.
  • Added unit test cases using karma, jasmine which had an impact on the overall performance of the app.

VOLUNTEER/MENTORSHIP/EXPERIENCE​

GoogleCSFirst|TeensCanCode: Lagos — Facilitator​

Aug. 2019 - Oct 2019

  • Organized and Trained people and students on scratch using the Google CSFirst curriculum

Google Code-In — Mentor certificate​

Jan 2020

  • Certificate for the successful completion of the program.

Google Summer Of Code - Mentor​

June - Aug. 2020

Google Season Of Docs - Mentor​

May - Dec. 2022

  • Certificate for the successful completion of the program.

Skills​

  • Writing Categories: User manuals and guides, API documentation, Technical specifications, Whitepapers, Tutorials, How-to guides, Blogs
  • Domain: DevOps, Cloud computing, Web development, IOT, Data Science, Blockchain and Web 3, Software development, Version control & Git, Data automation, Database management
  • Tools & Platforms: Swagger(OpenAPI), Medium. Zendesk, Adobe RoboHelp, MadCap Flare, Gitbook, Markdown, Docusarus
  • Design: Figma, Sketch, Photoshop, Canva, Illustrator
  • Languages: English.
- + \ No newline at end of file diff --git a/docs/writing-sample/api/index.html b/docs/writing-sample/api/index.html index 4eaa91e4..555a18d2 100644 --- a/docs/writing-sample/api/index.html +++ b/docs/writing-sample/api/index.html @@ -5,13 +5,13 @@ API Documentation | Hi, I am Favour Kelvin - +

API Documentation

Welcome to the API Documentation section of my portfolio! As a dedicated technical writer, I excel in creating clear, detailed, and user-friendly API documentation that facilitates seamless integration and interaction with software systems. Below, you'll find a sample of my work in this realm:

Project: Mindee REST API Guide​

Description: Crafted a comprehensive API documentation guide for the Mindee REST API, enabling developers to effectively utilize its powerful document parsing capabilities. The documentation covers various aspects, including authentication, document inputs, working with images and PDFs, making API calls, handling predictions, error management, and technical limitations.

Role: Lead API Technical Writer

Tools Used: Markdown

Approach: Collaborated closely with Mindee's development team to gain in-depth insights into the REST API's functionalities and intended use cases. The documentation emphasizes clarity, practical examples, and adherence to best practices for API integration.

Key Sections:

  1. Authentication and Authorization:

    • Provided a comprehensive guide to authenticating API requests using API Keys, with an emphasis on security practices.
    • Highlighted the importance of keeping API keys confidential and avoiding exposure.

  2. Document Inputs:

    • Introduced the concept of documents within Mindee, including supported file types such as images (JPG, PNG, WEBP, TIFF, HEIC) and PDFs.
    • Detailed payload formats for sending documents, including binary files, base64 encoding, and public URLs.

  3. Working with Images:

    • Covered optimal practices for working with images, including supported file formats and tips for better processing.
    • Emphasized the advantages of images over PDFs for faster processing.

  4. Working with PDFs:

    • Explained how to work with multi-page PDF files, including usage of native PDFs and the use of the cutPdf option.
    • Provided tips for effective processing and handling of PDF documents.

  5. API Calls and Endpoints:

    • Described the various Mindee REST API endpoints, including the Predictions Endpoint, with detailed URL patterns and base URL structure.

  6. Authentication in API Calls:

    • Illustrated how to include API keys in API requests using custom HTTP Authorization headers.
    • Addressed scenarios for off-the-shelf APIs and custom APIs.

  7. JSON Response and Predictions:

    • Explained the structure of JSON responses, including the api_request object and the document object containing predictions.
    • Provided examples of prediction objects with various fields and values.

  8. Error Management:

    • Detailed Mindee's REST API status and error codes, with explanations of common error scenarios and their corresponding HTTP status codes.

  9. Technical Limitations:

    • Outlined the rate limits, payload constraints, and data model limitations enforced within the Mindee REST API.
    • Offered guidance on optimizing API usage and staying within the specified limits.

API Documentation sample docs​

If you're interested in exploring more of my API documentation work or would like to discuss potential collaboration opportunities, please feel free to contact me.

- + \ No newline at end of file diff --git a/docs/writing-sample/blogs/index.html b/docs/writing-sample/blogs/index.html index dad203a5..4c53a467 100644 --- a/docs/writing-sample/blogs/index.html +++ b/docs/writing-sample/blogs/index.html @@ -5,13 +5,13 @@ Blogs and Articles Writing Sample | Hi, I am Favour Kelvin - +

Blogs and Articles Writing Sample

Welcome to my Blogs and Articles writing sample section! As a proficient writer, I enjoy creating engaging and informative blog posts and articles on a wide range of topics. Below are some examples of my work in this domain:

Article: "How to Evaluate and Load a PyTorch Model with Giskard"​

Description: This article takes you through the process of uploading a PyTorch model to Giskard, a tool designed to identify potential errors and biases. It addresses the challenges of training and testing PyTorch models and demonstrates how Giskard can help ensure model quality.

Platform: Giskard

Key Points:

  • Explores the common challenges faced when training PyTorch models and the importance of model evaluation.
  • Introduces Giskard as a tool for testing and analyzing PyTorch models for biases, robustness, and discriminative behavior.
  • Provides step-by-step instructions for building a PyTorch model, wrapping it with Giskard, and analyzing it for potential issues.
  • Demonstrates how Giskard's UI can be used to debug tests, compare models, and collaborate on model analysis.
  • Includes a guide for uploading pre-trained models, specifically the XLM-ROBERTA model, for fine-tuning and further analysis.

This article showcases my ability to explain complex concepts clearly and guide readers through practical implementations. If you're interested in exploring more articles or have specific topics in mind, please feel free to contact me. I'm enthusiastic about contributing to your content needs!

Read Article

Article: "Mailchimp Database Integration Guide: How to Connect Any App to Mailchimp"​

Description: Explored the process of integrating Mailchimp with various applications and databases, enabling users to harness the power of data synchronization for enhanced marketing and outreach.

Date: July 14, 2022

Platform: [Coupler.io][https://www.coupler.io/]

Key Points:

  • Discussed the significance of integrating Mailchimp with other platforms to expand businesses' reach and boost revenue.
  • Detailed the requirements for Mailchimp database integration, including having a Mailchimp account and familiarity with databases.
  • Explored the benefits of effective Mailchimp database management, such as targeted email campaigns and improved communication.
  • Described the structure of a Mailchimp database, including audience, record, field, segment, group, and tag.
  • Explored different types of Mailchimp integrations, including linking e-commerce data, customer data, and website pop-up forms.
  • Outlined steps to connect a local database to Mailchimp using tools like Coupler.io.
  • Explained Mailchimp SQL database integration and how to access Mailchimp API using tools like curl.
  • Provided a no-code alternative using Coupler.io to connect databases to Mailchimp.
  • Guided readers through steps to load a database of contacts to Mailchimp and copy contacts from Mailchimp.
  • Shared best practices for Mailchimp database integration, such as defining integration purpose and syncing frequency.

Read Full Article

List of articles written by Me​

View on Gsheets

This showcase my ability to deliver insightful and engaging content on various subjects. If you're interested in collaborating on similar projects or would like more details, please feel free to contact me. I'm excited to contribute to your content needs!

- + \ No newline at end of file diff --git a/docs/writing-sample/faqs/index.html b/docs/writing-sample/faqs/index.html index 2cbb7d13..7bc755a8 100644 --- a/docs/writing-sample/faqs/index.html +++ b/docs/writing-sample/faqs/index.html @@ -5,13 +5,13 @@ Troubleshooting and FAQ Writing Portfolio Sample | Hi, I am Favour Kelvin - +
-

Troubleshooting and FAQ Writing Portfolio Sample

Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:

Project: Bacalhau FAQs​

Description: Developed detailed troubleshooting and frequently asked questions (FAQ) documentation for Bacalhau, a versatile computing platform, to assist users in resolving common problems and queries.

Role: Lead Technical Writer

Approach: My approach prioritized user-centricity, aiming to simplify complex technical issues and provide step-by-step solutions that users of all levels could follow effortlessly.

Key Sections:

  1. Can I use multiple data sources in the same job?

    • Answered how users can utilize multiple data sources in a Bacalhau job.

  2. How can I submit Job requests through CLI to communicate with my Node directly?

    • Provided instructions on configuring CLI to communicate directly with Bacalhau nodes.

  3. Why does my API server listen on /ip4/127.0.0.1/tcp/5001 when I invoke IPFS Daemon when fetching an IPFS Multiaddress?

    • Explained the reasons for this behavior and how to address it.

  4. What to do when I get error connection refused when running Bacalhau API?

    • Offered troubleshooting steps for resolving connection issues with Bacalhau API.

  5. Can I run Bacalhau in a containerized setup (nested containers)?

    • Addressed the feasibility of running Bacalhau in a containerized setup.

  6. Can I run non-Docker jobs?

    • Explained the possibility of running non-Docker jobs using WebAssembly.

  7. How do I run a script that requires installing packages from a package repository like pypi or apt?

    • Provided guidance on running scripts with external package dependencies.

  8. How do I see a job’s progress while it’s running?

    • Clarified the current limitations regarding job progress tracking.

  9. How do I get an IPFS peer if I want to start Bacalhau Server?

    • Explained how to obtain an IPFS peer for Bacalhau Server.

  10. How can I download and query SQLite when it complains about being in a read-only directory?

    • Provided a solution for running SQLite in a read-only directory.

  11. Can I run Bacalhau serve on my home machine? What are the requirements?

    • Clarified the system requirements for running Bacalhau serve.

  12. Can I stop a running job?

    • Informed users about the process of stopping a running Bacalhau job.

Troubleshooting & FAQ Writing sample docs​

If you're interested in collaborating on similar projects or would like more details, please don't hesitate to contact me. I'm enthusiastic about helping you create effective troubleshooting guides and FAQs for your products!

You can expect the same level of professionalism and user-focused approach in all my troubleshooting and FAQ writing projects.

- +

Troubleshooting and FAQ Writing Portfolio Sample

Welcome to my Troubleshooting and FAQ Writing portfolio section! As a technical writer, I excel in creating comprehensive troubleshooting guides and FAQ documents that provide users with clear solutions to common issues. Below is an example of my work in this category:

Project: Bacalhau FAQs​

Description: Developed detailed troubleshooting and frequently asked questions (FAQ) documentation for Bacalhau, a versatile computing platform, to assist users in resolving common problems and queries.

Role: Lead Technical Writer

Approach: My approach prioritized user-centricity, aiming to simplify complex technical issues and provide step-by-step solutions that users of all levels could follow effortlessly.

Key Sections:

  1. Can I use multiple data sources in the same job?

    • Answered how users can utilize multiple data sources in a Bacalhau job.

  2. How can I submit Job requests through CLI to communicate with my Node directly?

    • Provided instructions on configuring CLI to communicate directly with Bacalhau nodes.

  3. Why does my API server listen on /ip4/127.0.0.1/tcp/5001 when I invoke IPFS Daemon when fetching an IPFS Multiaddress?

    • Explained the reasons for this behavior and how to address it.

  4. What to do when I get error connection refused when running Bacalhau API?

    • Offered troubleshooting steps for resolving connection issues with Bacalhau API.

  5. Can I run Bacalhau in a containerized setup (nested containers)?

    • Addressed the feasibility of running Bacalhau in a containerized setup.

  6. Can I run non-Docker jobs?

    • Explained the possibility of running non-Docker jobs using WebAssembly.

  7. How do I run a script that requires installing packages from a package repository like pypi or apt?

    • Provided guidance on running scripts with external package dependencies.

  8. How do I see a job’s progress while it’s running?

    • Clarified the current limitations regarding job progress tracking.

  9. How do I get an IPFS peer if I want to start Bacalhau Server?

    • Explained how to obtain an IPFS peer for Bacalhau Server.

  10. How can I download and query SQLite when it complains about being in a read-only directory?

    • Provided a solution for running SQLite in a read-only directory.

  11. Can I run Bacalhau serve on my home machine? What are the requirements?

    • Clarified the system requirements for running Bacalhau serve.

  12. Can I stop a running job?

    • Informed users about the process of stopping a running Bacalhau job.

Troubleshooting & FAQ Writing sample docs​

If you're interested in collaborating on similar projects or would like more details, please don't hesitate to contact me. I'm enthusiastic about helping you create effective troubleshooting guides and FAQs for your products!

You can expect the same level of professionalism and user-focused approach in all my troubleshooting and FAQ writing projects.

+ \ No newline at end of file diff --git a/docs/writing-sample/how-to-guide/index.html b/docs/writing-sample/how-to-guide/index.html index e3d6bb69..c128f974 100644 --- a/docs/writing-sample/how-to-guide/index.html +++ b/docs/writing-sample/how-to-guide/index.html @@ -5,13 +5,13 @@ How-to Guide Documentation Sample | Hi, I am Favour Kelvin - +
-

How-to Guide Documentation Sample

Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:

Project: Deploying a Voting Smart Contract Dapp on Calimero​

Description: Crafted a comprehensive how-to guide to walk users through the process of deploying a voting smart contract Dapp on the Calimero network.

Role: Lead Technical Writer

Approach: Prioritized user-friendliness and clarity in presenting the steps. The guide is designed to enable even novice users to deploy a voting Dapp successfully on the Calimero network.

Key Sections:

  1. Prerequisites:

    • Listed the requirements before beginning the deployment process, including setting up a Calimero private shard and installing necessary tools.

  2. Step 1: Build the Smart Contract:

    • Explained how to clone the Calimero examples repository, navigate to the private directory, and compile the Rust smart contract to WASM.

  3. Step 2: Generate an Auth Token:

    • Guided users in generating a Calimero auth token to authenticate and authorize external applications.

  4. Step 3: Set Up the NEAR CLI:

    • Provided instructions on how to set up the NEAR CLI for interaction with the Calimero shard.

  5. Step 4: Create a Keypair:

    • Detailed the process of creating a keypair for the shard account and locating the generated keypair file.

  6. Step 5: Create a Sub Account:

    • Guided users in creating a sub account from the Custodial account in the Calimero Console and adding a public key.

  7. Step 6: Deploy Your NEAR Contract:

    • Explained the deployment process, including setting variables, running the deployment command, and checking the deployed contract.

  8. Step 7: Update the Config File and Start the Dapp Frontend:

    • Provided instructions for configuring the Dapp frontend, including connection settings and starting the localhost server.

  9. Conclusion:

    • Summarized the deployment process and congratulated users on successfully deploying a voting application on the Calimero Network.

How-to-Guide Documentation Sample Docs​

If you're interested in collaborating on similar projects or would like more details, feel free to contact me. I'm excited to discuss how I can assist in creating effective how-to guides for your technical endeavors!

- +

How-to Guide Documentation Sample

Welcome to my How-to Guide Documentation portfolio section! As a technical writer, I specialize in creating clear and concise step-by-step guides that assist users in performing specific tasks. Below is an example of my work in this category:

Project: Deploying a Voting Smart Contract Dapp on Calimero​

Description: Crafted a comprehensive how-to guide to walk users through the process of deploying a voting smart contract Dapp on the Calimero network.

Role: Lead Technical Writer

Approach: Prioritized user-friendliness and clarity in presenting the steps. The guide is designed to enable even novice users to deploy a voting Dapp successfully on the Calimero network.

Key Sections:

  1. Prerequisites:

    • Listed the requirements before beginning the deployment process, including setting up a Calimero private shard and installing necessary tools.

  2. Step 1: Build the Smart Contract:

    • Explained how to clone the Calimero examples repository, navigate to the private directory, and compile the Rust smart contract to WASM.

  3. Step 2: Generate an Auth Token:

    • Guided users in generating a Calimero auth token to authenticate and authorize external applications.

  4. Step 3: Set Up the NEAR CLI:

    • Provided instructions on how to set up the NEAR CLI for interaction with the Calimero shard.

  5. Step 4: Create a Keypair:

    • Detailed the process of creating a keypair for the shard account and locating the generated keypair file.

  6. Step 5: Create a Sub Account:

    • Guided users in creating a sub account from the Custodial account in the Calimero Console and adding a public key.

  7. Step 6: Deploy Your NEAR Contract:

    • Explained the deployment process, including setting variables, running the deployment command, and checking the deployed contract.

  8. Step 7: Update the Config File and Start the Dapp Frontend:

    • Provided instructions for configuring the Dapp frontend, including connection settings and starting the localhost server.

  9. Conclusion:

    • Summarized the deployment process and congratulated users on successfully deploying a voting application on the Calimero Network.

How-to-Guide Documentation Sample Docs​

If you're interested in collaborating on similar projects or would like more details, feel free to contact me. I'm excited to discuss how I can assist in creating effective how-to guides for your technical endeavors!

+ \ No newline at end of file diff --git a/docs/writing-sample/newsletter/index.html b/docs/writing-sample/newsletter/index.html index 4011e508..78e3d7f3 100644 --- a/docs/writing-sample/newsletter/index.html +++ b/docs/writing-sample/newsletter/index.html @@ -5,14 +5,14 @@ Welcome to my Newsletter Writing Portfolio | Hi, I am Favour Kelvin - +

Welcome to my Newsletter Writing Portfolio

Welcome to my Newsletter Writing portfolio section! As a technical writer with a knack for effective communication, I specialize in crafting engaging and informative newsletters that captivate your audience. Below is an example of my work in this category:

Welcome to my Newsletter Writing portfolio section! As a technical writer with a knack for effective communication, I specialize in crafting engaging and informative newsletters that captivate your audience. Below is an example of my work in this category:

Project: Bacalhau Updates - February 2023​

Description: Crafted a compelling monthly newsletter for Bacalhau, a cutting-edge technology platform, to provide highlights of their latest release, upcoming events, exciting updates, and more.

Role: Lead Newsletter Writer

Approach: My approach to this newsletter was to blend technical depth with reader-friendly language. I aimed to ensure that even non-technical readers could grasp the valuable insights presented about Bacalhau's developments.

Key Sections:

  1. New in Bacalhau - Highlight:

    • Introduced the latest Bacalhau release with engaging poetry and highlighted key features and improvements.

  2. Improved telemetry:

    • Explained improvements in telemetry, including database calls, Docker orchestration, and Lotus node integration.

  3. Running jobs from FVM:

    • Detailed how Bacalhau can now be called directly from FVM smart contracts on the Filecoin Hyperspace testnet.

  4. Dockerized Bacalhau Server:

    • Described the option to run a Bacalhau server in Docker for improved flexibility.

  5. Accessible local private networks:

    • Highlighted the simplicity of setting up local private networks with in-process IPFS.

  6. Generic endpoint:

    • Explained the availability of a generic endpoint for running Bacalhau jobs from anywhere on the internet.

  7. Networking is now live:

    • Announced the deployment of Networking, enabling Bacalhau's broad usage.

  8. Python SDK automagic keypair:

    • Introduced the convenience of Bacalhau Python SDK in creating keypairs automatically.

  9. Event Recap:

    • Provided a recap of an insightful event featuring Bacalhau's product manager.

  10. Streaming & On-Prem Demo:

    • Demonstrated the practical usage of Bacalhau through a wifi intrusion detection streaming demo.

  11. Save the Date:

    • Promoted upcoming events where Bacalhau's team would be speaking and attending.

  12. Questions/comments? Let us know!:

    • Invited readers to engage with Bacalhau's team through various channels.

Newsletter Writing Sample​

If you're interested in collaborating on similar projects or would like to discuss how I can enhance your newsletters, please contact me. I look forward to helping you create compelling newsletters that resonate with your audience! This revised sample introduces the "Bacalhau Updates" newsletter and maintains the same professional and informative tone as the previous example.

- + \ No newline at end of file diff --git a/docs/writing-sample/release-notes/index.html b/docs/writing-sample/release-notes/index.html index 31f3a0ae..dadea51e 100644 --- a/docs/writing-sample/release-notes/index.html +++ b/docs/writing-sample/release-notes/index.html @@ -3,15 +3,15 @@ -Welcome to my Release Note Writing Portfolio Section | Hi, I am Favour Kelvin +Welcome to my Release Note Writing Portfolio Section | Hi, I am Favour Kelvin - +
-

Welcome to my Release Note Writing Portfolio Section

Greetings! As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users. Below, you will find an illustrative example of my proficiency in this specialized field:

Project: Launching WidgetPro Version 2.0​

Description: Crafted comprehensive release notes to accompany the launch of WidgetPro Version 2.0, a significant update to our versatile widget creation tool.

Role: Lead Technical Writer

Approach: My approach prioritizes clarity and conciseness in presenting complex technical changes, ensuring that users and stakeholders understand the impact of each update.

Key Sections:

  1. Introduction to WidgetPro 2.0:

    • Provided a brief overview of the WidgetPro software and highlighted the significance of the 2.0 update.

  2. Release Highlights:

    • Listed and summarized the key features and improvements brought by Version 2.0.

  3. Detailed Changes:

    • Presented an in-depth breakdown of technical changes, bug fixes, and performance enhancements.

  4. Known Issues and Workarounds:

    • Transparently acknowledged any known issues and provided solutions or workarounds where applicable.

  5. Upcoming Features Preview:

    • Gave users a sneak peek into upcoming features and improvements on the product roadmap.

  6. Feedback and Support:

    • Encouraged users to share their feedback, report issues, and offered avenues for customer support.

  7. Conclusion:

    • Summarized the significance of the update and expressed gratitude for user support and feedback.

Release Note Writing Sample Docs​

If you're interested in collaborating on similar projects or require more information, please reach out. I'm enthusiastic about discussing how I can contribute to creating informative and engaging release notes for your products!

- +

Welcome to my Release Note Writing Portfolio Section

As a dedicated technical writer, I excel in creating meticulous and informative release notes that serve as essential communication tools between your product development team and your valued users.

Project: Mindee Invoice OCR release notes​

Description: Crafted comprehensive release notes to accompany the launch of WidgetPro Version 2.0, a significant update to our versatile widget creation tool.

Role: Lead Technical Writer

Approach: My approach prioritizes clarity and conciseness in presenting complex technical changes, ensuring that users and stakeholders understand the impact of each update.

Release Note Writing Sample Docs​

If you're interested in collaborating on similar projects or require more information, please reach out. I'm enthusiastic about discussing how I can contribute to creating informative and engaging release notes for your products!

+ \ No newline at end of file diff --git a/docs/writing-sample/tutorial/index.html b/docs/writing-sample/tutorial/index.html index 36037590..91a17424 100644 --- a/docs/writing-sample/tutorial/index.html +++ b/docs/writing-sample/tutorial/index.html @@ -5,13 +5,13 @@ Tutorials Sample | Hi, I am Favour Kelvin - +

Tutorials Sample

Welcome to my Tutorials portfolio section! As a technical writer, I specialize in creating comprehensive and easy-to-follow tutorials that guide users through complex processes step by step. Below, you'll find an example of my work in this domain:

Project: Reading Data from Multiple S3 Buckets using Bacalhau​

Description: Developed an in-depth tutorial on how to efficiently read data from multiple Amazon S3 buckets using Bacalhau, a powerful data processing platform. The tutorial focuses on converting TIFF images to JPEG format while leveraging the advantages of Bacalhau's S3 integration.

Role: Lead Technical Writer

Tools Used: Markdown

Approach: Understanding the diverse skill levels of users, the tutorial is structured to gradually introduce concepts. It begins with explaining the integration's benefits and then delves into step-by-step instructions for running jobs on multiple S3 buckets.

Key Sections:

  1. Introduction:
    • Introduced Bacalhau's S3 integration and its significance in data processing.
    • Highlighted the advantages of converting TIFF images to JPEG format.
  2. Advantages of Converting TIFF to JPEG:
    • Discussed the benefits of using JPEG format for data processing tasks.
    • Emphasized reduced file size, efficient processing, and suitability for machine learning.
  3. Running the Job on Bacalhau:
    • Demonstrated how to utilize Bacalhau's S3 mount feature to access bucket objects.
    • Showcased the process of running a job on multiple buckets located in different regions.
  4. Prerequisite:
    • Provided instructions for installing the Bacalhau client to get started.
  5. Running the Job on Multiple Buckets:
    • Presented the command-line flags and breakdown for running jobs on multiple buckets.
    • Explained the flag meanings and how to specify source, destination, and region.
  6. Checking Job Status:
    • Guided users on how to check the status of a submitted job using the bacalhau list command.
  7. Job Information and Download:
    • Explained how to retrieve more information about a job using bacalhau describe.
    • Detailed the process of downloading job results using bacalhau get.
  8. Viewing Job Output:
    • Provided Python code to display converted JPEG images using PIL and IPython.
    • Illustrated how to visualize the output images stored in the results/outputs directory.

Tutorial Documentation sample docs​

If you're interested in collaborating on similar projects or would like more details, feel free to contact me. I'm excited to explore opportunities to contribute to your tutorials documentation needs!

- + \ No newline at end of file diff --git a/docs/writing-sample/user-manual/index.html b/docs/writing-sample/user-manual/index.html index 33905008..f7534431 100644 --- a/docs/writing-sample/user-manual/index.html +++ b/docs/writing-sample/user-manual/index.html @@ -5,13 +5,13 @@ User Manuals and Guides | Hi, I am Favour Kelvin - +

User Manuals and Guides

Welcome to my User Manuals and Guides portfolio section! As a technical writer, I specialize in crafting clear and comprehensive user documentation that helps users navigate and utilize products effectively. Below are some examples of my work in this domain:

Project: Getting Started with Bacalhau​

Description: Developed a comprehensive tutorial to guide users through installing and running jobs with the Bacalhau client, utilizing both the Bacalhau CLI and Docker.

Role: Lead Technical Writer

Tools Used: Docusaurus, Markdown

Approach: Conducted thorough research to understand user needs and pain points. The tutorial emphasizes simplicity, providing step-by-step instructions to enable users to confidently initiate tasks without complexity.

Key Sections:​

  1. Bacalhau Client Overview:
    • Introduced the Bacalhau client and its significance in job submission.
    • Covered compatibility across Linux, macOS, and Windows, including Docker integration.
  2. Installing the Bacalhau CLI:
    • Provided detailed installation steps for the CLI, including potential sudo or root password requirements.
    • Addressed Windows installation with a separate download option.
  3. Running with Docker:
    • Introduced Docker-based job execution.
    • Explained version-specific Docker commands and usage.
  4. Verification and Version Check:
    • Guided users in confirming their installation and checking client and server versions.
  5. Submitting a Job:
    • Illustrated usage of the bacalhau docker run command.
    • Included an example "Hello World" submission within an Ubuntu container.
  6. Monitoring Job Status:
    • Described how to monitor submitted jobs using bacalhau list.
  7. Retrieving and Viewing Job Output:
    • Explained how to retrieve and view job results using bacalhau get.
    • Guided users through accessing output files.

User manual and Guide sample docs​

If you're interested in collaborating on similar projects or would like more details, please don't hesitate to contact me. I'm excited to discuss how I can contribute to your next user documentation endeavor!

- + \ No newline at end of file diff --git a/index.html b/index.html index f0b38d3a..e6c0ab5c 100644 --- a/index.html +++ b/index.html @@ -5,13 +5,13 @@ Hello from Hi, I am Favour Kelvin | Hi, I am Favour Kelvin - +

Hi, I am Favour Kelvin

A technical writer and developer advocate

Click here to view my portfolio 🧐
Easy to Use

Work Experience

For information about me and a link to my downloadable resume.

Focus on What Matters

Writing Samples

For examples of my work.

Powered by React

Articles Written

List of articles written

Image 1Image 2
- + \ No newline at end of file diff --git a/markdown-page/index.html b/markdown-page/index.html index 3e289d7e..7da98bb8 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -5,13 +5,13 @@ Markdown page example | Hi, I am Favour Kelvin - +

Markdown page example

You don't need React to write simple standalone pages.

- + \ No newline at end of file