From 5281820855f76a60405892c7076df2c50fe42d9a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 20 Jun 2023 16:17:12 +0000 Subject: [PATCH] deploy: 35d79c933b3a8716f8ec6421ca2cbea69be5a742 --- 404.html | 4 ++-- about/index.html | 4 ++-- assets/js/{935f2afb.8cff5fd9.js => 935f2afb.1a4aae38.js} | 2 +- assets/js/b51a1159.47aaf950.js | 1 - assets/js/b51a1159.701a27cd.js | 1 + ...{runtime~main.bfc5014f.js => runtime~main.3c17ec2f.js} | 2 +- category/-onboarding-setup/index.html | 4 ++-- category/-technical-writing/index.html | 6 +++--- index.html | 4 ++-- markdown-page/index.html | 4 ++-- onboarding/ckan-setup/index.html | 4 ++-- onboarding/datapusher-plus-setup/index.html | 4 ++-- onboarding/qsv-setup/index.html | 4 ++-- onboarding/setup-overview/index.html | 4 ++-- onboarding/ubuntu-vm-setup/index.html | 4 ++-- qsv-whirlwind-tour/index.html | 4 ++-- technical-writing/daily-standups/index.html | 4 ++-- technical-writing/kanban-boards/index.html | 4 ++-- technical-writing/markdown/index.html | 4 ++-- technical-writing/technical-writing-overview/index.html | 8 ++++---- 20 files changed, 38 insertions(+), 38 deletions(-) rename assets/js/{935f2afb.8cff5fd9.js => 935f2afb.1a4aae38.js} (91%) delete mode 100644 assets/js/b51a1159.47aaf950.js create mode 100644 assets/js/b51a1159.701a27cd.js rename assets/js/{runtime~main.bfc5014f.js => runtime~main.3c17ec2f.js} (97%) diff --git a/404.html b/404.html index d2e7a41..7ae6896 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ Page Not Found | Data Engineering Intern Onboarding Guide - +
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/about/index.html b/about/index.html index f50e256..82a002e 100644 --- a/about/index.html +++ b/about/index.html @@ -4,13 +4,13 @@ 🍃 About the Guide | Data Engineering Intern Onboarding Guide - +
Skip to main content

🍃 About the Guide

This guide serves as a reference guide for new data engineering interns at datHere.

⚡ Quick links!​

🔍 Found a mistake in the guide?​

Feel free to contribute to this site by clicking the "Edit this page" button at the bottom of any page on the guide to make a PR on our GitHub repository.

It helps keeping content up to date and accurate for future interns and for your own reference! 🌌

- + \ No newline at end of file diff --git a/assets/js/935f2afb.8cff5fd9.js b/assets/js/935f2afb.1a4aae38.js similarity index 91% rename from assets/js/935f2afb.8cff5fd9.js rename to assets/js/935f2afb.1a4aae38.js index caf157b..1f9e742 100644 --- a/assets/js/935f2afb.8cff5fd9.js +++ b/assets/js/935f2afb.1a4aae38.js @@ -1 +1 @@ -"use strict";(self.webpackChunkde_intern_tutorial=self.webpackChunkde_intern_tutorial||[]).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":{"guideSidebar":[{"type":"link","label":"\ud83d\udc4b Welcome to datHere!","href":"/de-intern-guide/","docId":"intro"},{"type":"category","label":"\u2708 Onboarding Setup","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"\ud83d\uddfa Setup Overview","href":"/de-intern-guide/onboarding/setup-overview","docId":"onboarding/setup-overview"},{"type":"link","label":"\ud83d\udcbb Ubuntu VM Setup","href":"/de-intern-guide/onboarding/ubuntu-vm-setup","docId":"onboarding/ubuntu-vm-setup"},{"type":"link","label":"\u26a1 qsv Setup","href":"/de-intern-guide/onboarding/qsv-setup","docId":"onboarding/qsv-setup"},{"type":"link","label":"\ud83d\udcca CKAN Setup","href":"/de-intern-guide/onboarding/ckan-setup","docId":"onboarding/ckan-setup"},{"type":"link","label":"\ud83d\udcee DataPusher+ Setup","href":"/de-intern-guide/onboarding/datapusher-plus-setup","docId":"onboarding/datapusher-plus-setup"}],"href":"/de-intern-guide/category/-onboarding-setup"},{"type":"category","label":"\u270d Technical Writing","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"\ud83d\uddfa Technical Writing Overview","href":"/de-intern-guide/technical-writing/technical-writing-overview","docId":"technical-writing/technical-writing-overview"},{"type":"link","label":"\ud83d\udcdd Markdown","href":"/de-intern-guide/technical-writing/markdown","docId":"technical-writing/markdown"},{"type":"link","label":"\u2615 Daily Standups","href":"/de-intern-guide/technical-writing/daily-standups","docId":"technical-writing/daily-standups"},{"type":"link","label":"\ud83d\udef9 Kanban Boards","href":"/de-intern-guide/technical-writing/kanban-boards","docId":"technical-writing/kanban-boards"}],"href":"/de-intern-guide/category/-technical-writing"},{"type":"link","label":"\ud83c\udf2a qsv Whirlwind Tour","href":"/de-intern-guide/qsv-whirlwind-tour","docId":"qsv-whirlwind-tour"}]},"docs":{"intro":{"id":"intro","title":"\ud83d\udc4b Welcome to datHere!","description":"{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"guideSidebar":[{"type":"link","label":"\ud83d\udc4b Welcome to datHere!","href":"/de-intern-guide/","docId":"intro"},{"type":"category","label":"\u2708 Onboarding Setup","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"\ud83d\uddfa Setup Overview","href":"/de-intern-guide/onboarding/setup-overview","docId":"onboarding/setup-overview"},{"type":"link","label":"\ud83d\udcbb Ubuntu VM Setup","href":"/de-intern-guide/onboarding/ubuntu-vm-setup","docId":"onboarding/ubuntu-vm-setup"},{"type":"link","label":"\u26a1 qsv Setup","href":"/de-intern-guide/onboarding/qsv-setup","docId":"onboarding/qsv-setup"},{"type":"link","label":"\ud83d\udcca CKAN Setup","href":"/de-intern-guide/onboarding/ckan-setup","docId":"onboarding/ckan-setup"},{"type":"link","label":"\ud83d\udcee DataPusher+ Setup","href":"/de-intern-guide/onboarding/datapusher-plus-setup","docId":"onboarding/datapusher-plus-setup"}],"href":"/de-intern-guide/category/-onboarding-setup"},{"type":"category","label":"\u270d Technical Writing","collapsible":true,"collapsed":true,"items":[{"type":"link","label":"\ud83d\uddfa Technical Writing Overview","href":"/de-intern-guide/technical-writing/technical-writing-overview","docId":"technical-writing/technical-writing-overview"},{"type":"link","label":"\ud83d\udcdd Markdown","href":"/de-intern-guide/technical-writing/markdown","docId":"technical-writing/markdown"},{"type":"link","label":"\u2615 Daily Standups","href":"/de-intern-guide/technical-writing/daily-standups","docId":"technical-writing/daily-standups"},{"type":"link","label":"\ud83d\udef9 Kanban Boards","href":"/de-intern-guide/technical-writing/kanban-boards","docId":"technical-writing/kanban-boards"}],"href":"/de-intern-guide/category/-technical-writing"},{"type":"link","label":"\ud83c\udf2a qsv Whirlwind Tour","href":"/de-intern-guide/qsv-whirlwind-tour","docId":"qsv-whirlwind-tour"}]},"docs":{"intro":{"id":"intro","title":"\ud83d\udc4b Welcome to datHere!","description":"{n.d(t,{Zo:()=>u,kt:()=>h});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=r.createContext({}),s=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},u=function(e){var t=s(e.components);return r.createElement(c.Provider,{value:t},e.children)},p="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,c=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),p=s(n),m=a,h=p["".concat(c,".").concat(m)]||p[m]||d[m]||i;return n?r.createElement(h,o(o({ref:t},u),{},{components:n})):r.createElement(h,o({ref:t},u))}));function h(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,o=new Array(i);o[0]=m;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[p]="string"==typeof e?e:a,o[1]=l;for(var s=2;s{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>d,frontMatter:()=>i,metadata:()=>l,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const i={sidebar_position:1},o="\ud83d\uddfa Technical Writing Overview",l={unversionedId:"technical-writing/technical-writing-overview",id:"technical-writing/technical-writing-overview",title:"\ud83d\uddfa Technical Writing Overview",description:"Though programming is a large part of software development, it's not the only part. In fact, it can become a small part. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through technical writing.",source:"@site/docs/technical-writing/technical-writing-overview.md",sourceDirName:"technical-writing",slug:"/technical-writing/technical-writing-overview",permalink:"/de-intern-guide/technical-writing/technical-writing-overview",draft:!1,editUrl:"https://github.com/dathere/de-intern-guide/tree/main/docs/technical-writing/technical-writing-overview.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"guideSidebar",previous:{title:"\u270d Technical Writing",permalink:"/de-intern-guide/category/-technical-writing"},next:{title:"\ud83d\udcdd Markdown",permalink:"/de-intern-guide/technical-writing/markdown"}},c={},s=[{value:"\ud83d\udcad Why Learn About Technical Writing?",id:"-why-learn-about-technical-writing",level:2},{value:"\u2705 Clear communication",id:"-clear-communication",level:3},{value:"\ud83d\udc54 Professional documentation",id:"-professional-documentation",level:3},{value:"\ud83d\udc4d User-friendly content",id:"-user-friendly-content",level:3},{value:"\ud83d\udee0 Maintainable projects",id:"-maintainable-projects",level:3},{value:"\ud83d\ude80 Improvement & collaboration",id:"-improvement--collaboration",level:3},{value:"\ud83d\udcdd Where Can I Practice Technical Writing?",id:"-where-can-i-practice-technical-writing",level:2},{value:"\ud83d\udd0d Where Can I Learn More?",id:"-where-can-i-learn-more",level:2}],u={toc:s},p="wrapper";function d(e){let{components:t,...n}=e;return(0,a.kt)(p,(0,r.Z)({},u,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"-technical-writing-overview"},"\ud83d\uddfa Technical Writing Overview"),(0,a.kt)("p",null,"Though programming is a large part of software development, it's not the only part. In fact, it can become a small part. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through ",(0,a.kt)("strong",{parentName:"p"},"technical writing"),"."),(0,a.kt)("h2",{id:"-why-learn-about-technical-writing"},"\ud83d\udcad Why Learn About Technical Writing?"),(0,a.kt)("p",null,"Technical writing offers several benefits that can enhance your professional communication skills and help others make sense of your work, be it a codebase, a project, or any other technical subject."),(0,a.kt)("p",null,"Here are some benefits of technical writing:"),(0,a.kt)("h3",{id:"-clear-communication"},"\u2705 Clear communication"),(0,a.kt)("p",null,"Technical writing isn't about using overly complex language that just ends up being difficult to understand. It's about taking complex information and conveying them in a clear and concise manner."),(0,a.kt)("h3",{id:"-professional-documentation"},"\ud83d\udc54 Professional documentation"),(0,a.kt)("p",null,"Technical writing can help you create professional documentation for your projects, which can help others understand your work and potentially contribute to it. Writing professional reports, proposals, presentations, and more in an organized manner can enhance your professional credibility and communication skills."),(0,a.kt)("h3",{id:"-user-friendly-content"},"\ud83d\udc4d User-friendly content"),(0,a.kt)("p",null,"Understanding your audience and what their needs, preferences, and level of expertise can help you create content that is easy to understand and accessible. This can be very helpful for creating user-friendly documentation, such as tutorials, guides, and manuals."),(0,a.kt)("h3",{id:"-maintainable-projects"},"\ud83d\udee0 Maintainable projects"),(0,a.kt)("p",null,"Just like building furniture without instructions can be like a nightmare, working and maintaining a project without documentation can be like a nightmare. Technical writing can help you share documentation that can help you and others maintain your projects and codebases."),(0,a.kt)("h3",{id:"-improvement--collaboration"},"\ud83d\ude80 Improvement & collaboration"),(0,a.kt)("p",null,"Sharing your work with others can help you get valuable feedback from your audience to improve your work, while also allowing others to learn from your work and potentially contribute to it."),(0,a.kt)("h2",{id:"-where-can-i-practice-technical-writing"},"\ud83d\udcdd Where Can I Practice Technical Writing?"),(0,a.kt)("p",null,"You can practice technical writing in many different scenarios, such as:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Code/API/Project Documentation"),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"daily-standups"},"Daily standup notes")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"kanban-boards"},"Kanban boards")),(0,a.kt)("li",{parentName:"ul"},"Code comments"),(0,a.kt)("li",{parentName:"ul"},"GitHub issues"),(0,a.kt)("li",{parentName:"ul"},"GitHub pull requests"),(0,a.kt)("li",{parentName:"ul"},"Blog posts"),(0,a.kt)("li",{parentName:"ul"},"Case studies")),(0,a.kt)("h2",{id:"-where-can-i-learn-more"},"\ud83d\udd0d Where Can I Learn More?"),(0,a.kt)("p",null,"Practicing technical writing while getting feedback from others is a great way to learn where you can improve."),(0,a.kt)("p",null,"If you'd like to take courses on technical writing, here are a few technical writing courses from Google that you can take for free:"),(0,a.kt)("table",null,(0,a.kt)("thead",{parentName:"table"},(0,a.kt)("tr",{parentName:"thead"},(0,a.kt)("th",{parentName:"tr",align:null},"Course"),(0,a.kt)("th",{parentName:"tr",align:null},"Summary"))),(0,a.kt)("tbody",{parentName:"table"},(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/one"},"Technical Writing One")),(0,a.kt)("td",{parentName:"tr",align:null},"Learn the critical basics of technical writing. Take this course before taking any of the other courses.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/two"},"Technical Writing Two")),(0,a.kt)("td",{parentName:"tr",align:null},"Practice four intermediate topics in technical writing.")),(0,a.kt)("tr",{parentName:"tbody"},(0,a.kt)("td",{parentName:"tr",align:null},(0,a.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/error-messages"},"Writing Helpful Error Messages")),(0,a.kt)("td",{parentName:"tr",align:null},"Write clearer, more effective error messages, whether they appear in IDEs, command lines, or GUIs.")))),(0,a.kt)("p",null,"I suggest adding course recommendations to your ",(0,a.kt)("a",{parentName:"p",href:"kanban-boards"},"kanban board")," and updating your progress as you go through them."),(0,a.kt)("p",null,"More importantly however, I suggest practicing technical writing in various scenarios and getting feedback from others."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b51a1159.701a27cd.js b/assets/js/b51a1159.701a27cd.js new file mode 100644 index 0000000..c8cb28e --- /dev/null +++ b/assets/js/b51a1159.701a27cd.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkde_intern_tutorial=self.webpackChunkde_intern_tutorial||[]).push([[627],{3905:(e,t,n)=>{n.d(t,{Zo:()=>s,kt:()=>h});var r=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var c=r.createContext({}),u=function(e){var t=r.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},s=function(e){var t=u(e.components);return r.createElement(c.Provider,{value:t},e.children)},p="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,a=e.originalType,c=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),p=u(n),d=i,h=p["".concat(c,".").concat(d)]||p[d]||m[d]||a;return n?r.createElement(h,o(o({ref:t},s),{},{components:n})):r.createElement(h,o({ref:t},s))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=n.length,o=new Array(a);o[0]=d;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l[p]="string"==typeof e?e:i,o[1]=l;for(var u=2;u{n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>o,default:()=>m,frontMatter:()=>a,metadata:()=>l,toc:()=>u});var r=n(7462),i=(n(7294),n(3905));const a={sidebar_position:1},o="\ud83d\uddfa Technical Writing Overview",l={unversionedId:"technical-writing/technical-writing-overview",id:"technical-writing/technical-writing-overview",title:"\ud83d\uddfa Technical Writing Overview",description:"Though using a programming language may be important for your projects, communicating effectively is crucial for documenting your work. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through technical writing.",source:"@site/docs/technical-writing/technical-writing-overview.md",sourceDirName:"technical-writing",slug:"/technical-writing/technical-writing-overview",permalink:"/de-intern-guide/technical-writing/technical-writing-overview",draft:!1,editUrl:"https://github.com/dathere/de-intern-guide/tree/main/docs/technical-writing/technical-writing-overview.md",tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1},sidebar:"guideSidebar",previous:{title:"\u270d Technical Writing",permalink:"/de-intern-guide/category/-technical-writing"},next:{title:"\ud83d\udcdd Markdown",permalink:"/de-intern-guide/technical-writing/markdown"}},c={},u=[{value:"\ud83d\udcad Why Learn About Technical Writing?",id:"-why-learn-about-technical-writing",level:2},{value:"\u2705 Clear communication",id:"-clear-communication",level:3},{value:"\ud83d\udc54 Professional documentation",id:"-professional-documentation",level:3},{value:"\ud83d\udc4d User-friendly content",id:"-user-friendly-content",level:3},{value:"\ud83d\udee0 Maintainable projects",id:"-maintainable-projects",level:3},{value:"\ud83d\ude80 Improvement & collaboration",id:"-improvement--collaboration",level:3},{value:"\ud83d\udcdd Where Can I Practice Technical Writing?",id:"-where-can-i-practice-technical-writing",level:2},{value:"\ud83d\udd0d Where Can I Learn More?",id:"-where-can-i-learn-more",level:2}],s={toc:u},p="wrapper";function m(e){let{components:t,...n}=e;return(0,i.kt)(p,(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"-technical-writing-overview"},"\ud83d\uddfa Technical Writing Overview"),(0,i.kt)("p",null,"Though using a programming language may be important for your projects, communicating effectively is crucial for documenting your work. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through ",(0,i.kt)("strong",{parentName:"p"},"technical writing"),"."),(0,i.kt)("h2",{id:"-why-learn-about-technical-writing"},"\ud83d\udcad Why Learn About Technical Writing?"),(0,i.kt)("p",null,"Technical writing offers several benefits that can enhance your professional communication skills and help others make sense of your work, be it a codebase, a project, or any other technical subject."),(0,i.kt)("p",null,"Here are some benefits of technical writing:"),(0,i.kt)("h3",{id:"-clear-communication"},"\u2705 Clear communication"),(0,i.kt)("p",null,"Technical writing isn't about using overly complex language that just ends up being difficult to understand. It's about taking complex information and conveying them in a clear and concise manner."),(0,i.kt)("h3",{id:"-professional-documentation"},"\ud83d\udc54 Professional documentation"),(0,i.kt)("p",null,"Technical writing can help you create professional documentation for your projects, which can help others understand your work and potentially contribute to it. Writing professional reports, proposals, presentations, and more in an organized manner can enhance your professional credibility and communication skills."),(0,i.kt)("h3",{id:"-user-friendly-content"},"\ud83d\udc4d User-friendly content"),(0,i.kt)("p",null,"Understanding your audience and what their needs, preferences, and level of expertise can help you create content that is easy to understand and accessible. This can be very helpful for creating user-friendly documentation, such as tutorials, guides, and manuals."),(0,i.kt)("h3",{id:"-maintainable-projects"},"\ud83d\udee0 Maintainable projects"),(0,i.kt)("p",null,"Just like building furniture without instructions can be like a nightmare, working and maintaining a project without documentation can be like a nightmare. Technical writing can help you share documentation that can help you and others maintain your projects and codebases."),(0,i.kt)("h3",{id:"-improvement--collaboration"},"\ud83d\ude80 Improvement & collaboration"),(0,i.kt)("p",null,"Sharing your work with others can help you get valuable feedback from your audience to improve your work, while also allowing others to learn from your work and potentially contribute to it."),(0,i.kt)("h2",{id:"-where-can-i-practice-technical-writing"},"\ud83d\udcdd Where Can I Practice Technical Writing?"),(0,i.kt)("p",null,"You can practice technical writing in many different scenarios, such as:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Code/API/Project Documentation"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"daily-standups"},"Daily standup notes")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"kanban-boards"},"Kanban boards")),(0,i.kt)("li",{parentName:"ul"},"Code comments"),(0,i.kt)("li",{parentName:"ul"},"GitHub issues"),(0,i.kt)("li",{parentName:"ul"},"GitHub pull requests"),(0,i.kt)("li",{parentName:"ul"},"Blog posts"),(0,i.kt)("li",{parentName:"ul"},"Case studies")),(0,i.kt)("h2",{id:"-where-can-i-learn-more"},"\ud83d\udd0d Where Can I Learn More?"),(0,i.kt)("p",null,"Practicing technical writing while getting feedback from others is a great way to learn where you can improve."),(0,i.kt)("p",null,"If you'd like to take courses on technical writing, here are a few technical writing courses from Google that you can take for free:"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:null},"Course"),(0,i.kt)("th",{parentName:"tr",align:null},"Summary"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/one"},"Technical Writing One")),(0,i.kt)("td",{parentName:"tr",align:null},"Learn the critical basics of technical writing. Take this course before taking any of the other courses.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/two"},"Technical Writing Two")),(0,i.kt)("td",{parentName:"tr",align:null},"Practice four intermediate topics in technical writing.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},(0,i.kt)("a",{parentName:"td",href:"https://developers.google.com/tech-writing/error-messages"},"Writing Helpful Error Messages")),(0,i.kt)("td",{parentName:"tr",align:null},"Write clearer, more effective error messages, whether they appear in IDEs, command lines, or GUIs.")))),(0,i.kt)("p",null,"I suggest adding course recommendations to your ",(0,i.kt)("a",{parentName:"p",href:"kanban-boards"},"kanban board")," and updating your progress as you go through them."),(0,i.kt)("p",null,"More importantly however, I suggest practicing technical writing in various scenarios and getting feedback from others."))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.bfc5014f.js b/assets/js/runtime~main.3c17ec2f.js similarity index 97% rename from assets/js/runtime~main.bfc5014f.js rename to assets/js/runtime~main.3c17ec2f.js index 90fbd74..a6d4205 100644 --- a/assets/js/runtime~main.bfc5014f.js +++ b/assets/js/runtime~main.3c17ec2f.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,a,o,n={},f={};function i(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,i),r.loaded=!0,r.exports}i.m=n,i.c=f,e=[],i.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u=o)&&Object.keys(i.O).every((e=>i.O[e](r[d])))?r.splice(d--,1):(f=!1,o0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,i.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);i.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&a&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,i.d(o,n),o},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.f={},i.e=e=>Promise.all(Object.keys(i.f).reduce(((t,r)=>(i.f[r](e,t),t)),[])),i.u=e=>"assets/js/"+({53:"935f2afb",85:"1f391b9e",117:"356a0ac6",119:"a3696a00",152:"18d4c4b8",206:"f8409a7e",241:"01232042",262:"e27ea86e",329:"a9ca83f8",405:"a9ea4256",414:"393be207",432:"321014e7",514:"1be78505",617:"0ab13595",627:"b51a1159",762:"73ae107a",817:"14eb3368",828:"27c1efac",904:"1d769a5c",918:"17896441",920:"095073fd",985:"f269bf4d"}[e]||e)+"."+{53:"8cff5fd9",85:"9cf78ad5",117:"99ca91fc",119:"5ae05421",152:"5f163301",206:"5855893d",241:"9dc00bc5",262:"9df6f007",329:"9dc6b0fe",405:"dd38ca6a",414:"1d2f2320",432:"a44e453a",455:"907a2712",514:"542f6b54",617:"4413885a",627:"47aaf950",762:"26e546de",817:"56d64c00",828:"83ccb53f",904:"fdd7684e",918:"e27ac847",920:"5bfeb994",972:"0981a0e3",985:"e4b57e65"}[e]+".js",i.miniCssF=e=>{},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="de-intern-tutorial:",i.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var f,d;if(void 0!==r)for(var c=document.getElementsByTagName("script"),u=0;u{f.onerror=f.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],f.parentNode&&f.parentNode.removeChild(f),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(b.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=b.bind(null,f.onerror),f.onload=b.bind(null,f.onload),d&&document.head.appendChild(f)}},i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.p="/de-intern-guide/",i.gca=function(e){return e={17896441:"918","935f2afb":"53","1f391b9e":"85","356a0ac6":"117",a3696a00:"119","18d4c4b8":"152",f8409a7e:"206","01232042":"241",e27ea86e:"262",a9ca83f8:"329",a9ea4256:"405","393be207":"414","321014e7":"432","1be78505":"514","0ab13595":"617",b51a1159:"627","73ae107a":"762","14eb3368":"817","27c1efac":"828","1d769a5c":"904","095073fd":"920",f269bf4d:"985"}[e]||e,i.p+i.u(e)},(()=>{var e={303:0,532:0};i.f.j=(t,r)=>{var a=i.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var n=i.p+i.u(t),f=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",f.name="ChunkLoadError",f.type=o,f.request=n,a[1](f)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],f=r[1],d=r[2],c=0;if(n.some((t=>0!==e[t]))){for(a in f)i.o(f,a)&&(i.m[a]=f[a]);if(d)var u=d(i)}for(t&&t(r);c{"use strict";var e,t,r,a,o,n={},f={};function i(e){var t=f[e];if(void 0!==t)return t.exports;var r=f[e]={id:e,loaded:!1,exports:{}};return n[e].call(r.exports,r,r.exports,i),r.loaded=!0,r.exports}i.m=n,i.c=f,e=[],i.O=(t,r,a,o)=>{if(!r){var n=1/0;for(u=0;u=o)&&Object.keys(i.O).every((e=>i.O[e](r[d])))?r.splice(d--,1):(f=!1,o0&&e[u-1][2]>o;u--)e[u]=e[u-1];e[u]=[r,a,o]},i.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return i.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,i.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);i.r(o);var n={};t=t||[null,r({}),r([]),r(r)];for(var f=2&a&&e;"object"==typeof f&&!~t.indexOf(f);f=r(f))Object.getOwnPropertyNames(f).forEach((t=>n[t]=()=>e[t]));return n.default=()=>e,i.d(o,n),o},i.d=(e,t)=>{for(var r in t)i.o(t,r)&&!i.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},i.f={},i.e=e=>Promise.all(Object.keys(i.f).reduce(((t,r)=>(i.f[r](e,t),t)),[])),i.u=e=>"assets/js/"+({53:"935f2afb",85:"1f391b9e",117:"356a0ac6",119:"a3696a00",152:"18d4c4b8",206:"f8409a7e",241:"01232042",262:"e27ea86e",329:"a9ca83f8",405:"a9ea4256",414:"393be207",432:"321014e7",514:"1be78505",617:"0ab13595",627:"b51a1159",762:"73ae107a",817:"14eb3368",828:"27c1efac",904:"1d769a5c",918:"17896441",920:"095073fd",985:"f269bf4d"}[e]||e)+"."+{53:"1a4aae38",85:"9cf78ad5",117:"99ca91fc",119:"5ae05421",152:"5f163301",206:"5855893d",241:"9dc00bc5",262:"9df6f007",329:"9dc6b0fe",405:"dd38ca6a",414:"1d2f2320",432:"a44e453a",455:"907a2712",514:"542f6b54",617:"4413885a",627:"701a27cd",762:"26e546de",817:"56d64c00",828:"83ccb53f",904:"fdd7684e",918:"e27ac847",920:"5bfeb994",972:"0981a0e3",985:"e4b57e65"}[e]+".js",i.miniCssF=e=>{},i.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),i.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="de-intern-tutorial:",i.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var f,d;if(void 0!==r)for(var c=document.getElementsByTagName("script"),u=0;u{f.onerror=f.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],f.parentNode&&f.parentNode.removeChild(f),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(b.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=b.bind(null,f.onerror),f.onload=b.bind(null,f.onload),d&&document.head.appendChild(f)}},i.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},i.p="/de-intern-guide/",i.gca=function(e){return e={17896441:"918","935f2afb":"53","1f391b9e":"85","356a0ac6":"117",a3696a00:"119","18d4c4b8":"152",f8409a7e:"206","01232042":"241",e27ea86e:"262",a9ca83f8:"329",a9ea4256:"405","393be207":"414","321014e7":"432","1be78505":"514","0ab13595":"617",b51a1159:"627","73ae107a":"762","14eb3368":"817","27c1efac":"828","1d769a5c":"904","095073fd":"920",f269bf4d:"985"}[e]||e,i.p+i.u(e)},(()=>{var e={303:0,532:0};i.f.j=(t,r)=>{var a=i.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var n=i.p+i.u(t),f=new Error;i.l(n,(r=>{if(i.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),n=r&&r.target&&r.target.src;f.message="Loading chunk "+t+" failed.\n("+o+": "+n+")",f.name="ChunkLoadError",f.type=o,f.request=n,a[1](f)}}),"chunk-"+t,t)}},i.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],f=r[1],d=r[2],c=0;if(n.some((t=>0!==e[t]))){for(a in f)i.o(f,a)&&(i.m[a]=f[a]);if(d)var u=d(i)}for(t&&t(r);c ✈ Onboarding Setup | Data Engineering Intern Onboarding Guide - +

✈ Onboarding Setup

Installation instructions to setting up your workspace with the necessary software and tools.

- + \ No newline at end of file diff --git a/category/-technical-writing/index.html b/category/-technical-writing/index.html index 9617423..d18066f 100644 --- a/category/-technical-writing/index.html +++ b/category/-technical-writing/index.html @@ -4,13 +4,13 @@ ✍ Technical Writing | Data Engineering Intern Onboarding Guide - +
-

✍ Technical Writing

How to write technical documentation and organize your work.

- +

✍ Technical Writing

How to write technical documentation and organize your work.

+ \ No newline at end of file diff --git a/index.html b/index.html index bb8aca4..13a8393 100644 --- a/index.html +++ b/index.html @@ -4,13 +4,13 @@ 👋 Welcome to datHere! | Data Engineering Intern Onboarding Guide - +

👋 Welcome to datHere!

✨ Overview​

Glad to have you here 🎉! This guide serves as a reference guide for new data engineering interns at datHere.

If you have any more questions that aren't answered here, please reach out to your team members on Slack.

🙌 Sounds great! How do I get started?​

Click the "Next" button below to get started!

You can also navigate the guide using the sidebar on the left.

If you're on a mobile device you can click on the three lines in the top left corner to open the sidebar.

- + \ No newline at end of file diff --git a/markdown-page/index.html b/markdown-page/index.html index 03b086e..1ce4ab9 100644 --- a/markdown-page/index.html +++ b/markdown-page/index.html @@ -4,13 +4,13 @@ Markdown page example | Data Engineering Intern Onboarding Guide - +

Markdown page example

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

- + \ No newline at end of file diff --git a/onboarding/ckan-setup/index.html b/onboarding/ckan-setup/index.html index 7d62fee..0212094 100644 --- a/onboarding/ckan-setup/index.html +++ b/onboarding/ckan-setup/index.html @@ -4,13 +4,13 @@ 📊 CKAN Setup | Data Engineering Intern Onboarding Guide - +
- + \ No newline at end of file diff --git a/onboarding/datapusher-plus-setup/index.html b/onboarding/datapusher-plus-setup/index.html index 2fa0b45..b015319 100644 --- a/onboarding/datapusher-plus-setup/index.html +++ b/onboarding/datapusher-plus-setup/index.html @@ -4,13 +4,13 @@ 📮 DataPusher+ Setup | Data Engineering Intern Onboarding Guide - +
- + \ No newline at end of file diff --git a/onboarding/qsv-setup/index.html b/onboarding/qsv-setup/index.html index 973517b..06127d9 100644 --- a/onboarding/qsv-setup/index.html +++ b/onboarding/qsv-setup/index.html @@ -4,13 +4,13 @@ ⚡ qsv Setup | Data Engineering Intern Onboarding Guide - +

⚡ qsv Setup

In this section we'll go over how to install qsv and get it running on your Ubuntu VM.

📺 Video Tutorial​

Video Resources​

📝 Written Tutorial​

There are various methods for installing qsv. We've categorized the installation options based on your objective.

💻 Install qsv for general usage​

If you intend on using qsv as a command line tool anywhere on your system (globally), then choose and complete the steps for one of the following options to install qsv:

🛠 Install qsv for development​

If you intend on developing, maintaining, and/or contributing to qsv, complete the steps for option 4 to install qsv within a folder (locally).

- + \ No newline at end of file diff --git a/onboarding/setup-overview/index.html b/onboarding/setup-overview/index.html index a7007b6..569e3d8 100644 --- a/onboarding/setup-overview/index.html +++ b/onboarding/setup-overview/index.html @@ -4,13 +4,13 @@ 🗺 Setup Overview | Data Engineering Intern Onboarding Guide - +

🗺 Setup Overview

Before you start diving into awesome projects and working with your team, you'll need the right equipment 🛠💼.

Refer to the upcoming sections to help you install everything. For now, let's take a look at the cool tools you'll be setting up 🤘!

😎 Cool Tools!​

Software/ToolDescription
VirtualBoxVirtualBox is a virtualization software that allows you to run a virtual machine on your computer. Simply put, this program lets you have virtual computers inside your computer!
UbuntuUbuntu is a free and open-source operating system. It is a Linux distribution and is often useful for running on virtual machines.
qsvqsv (pronounced "Quicksilver") is a command line program for indexing, slicing, analyzing, filtering, enriching, validating & joining CSV files. Commands are simple, fast & composable.
CKANCKAN is an open-source DMS (data management system) for powering data hubs and data portals. CKAN makes it easy to publish, share, and use data. It powers hundreds of data portals worldwide.
DataPusher+ with DockerDataPusher+ is standalone web service that pushes data into the CKAN DataStore fast & reliably. We'll be setting up a containerized version of DataPusher+ by using Docker.

🧩 Putting It All Together​

We'll use VirtualBox to create a virtual machine (VM) running Ubuntu. On your VM you can use and contribute to qsv, CKAN (including CKAN extensions), DataPusher+, and much more! 🚀

One more thing! 🎈

Though using a VM is not required and you can do development on your own setup, the guide will cover running an Ubuntu guest OS through a VM using VirtualBox on a Windows 10 host OS. If you're using a different setup (such as a different host OS), you may need to adjust your steps accordingly.

- + \ No newline at end of file diff --git a/onboarding/ubuntu-vm-setup/index.html b/onboarding/ubuntu-vm-setup/index.html index 902f624..f1f8bfd 100644 --- a/onboarding/ubuntu-vm-setup/index.html +++ b/onboarding/ubuntu-vm-setup/index.html @@ -4,13 +4,13 @@ 💻 Ubuntu VM Setup | Data Engineering Intern Onboarding Guide - +

💻 Ubuntu VM Setup

In this section we cover how to install VirtualBox on your operating system (OS) and run Ubuntu 22.04.2 LTS on a virtual machine (VM).

📺 Video Tutorial​

Video Resources​

📝 Written Tutorial​

You may find more comprehensive instructions and details on the online user manual for VirtualBox 7.0.

📥 Download VirtualBox & the Extension Pack​

  1. Go to the VirtualBox downloads page.
  2. Download the VirtualBox platform package based on your computer's OS.

For example, since I'm on a computer running Windows 10 as my OS, then I would choose "Windows hosts".

  1. Download the VirtualBox Oracle VM VirtualBox Extension Pack.

VirtualBox download page

🛠 Install VirtualBox & the Extension Pack​

  1. Run the VirtualBox installer. Select Yes if prompted to allow VirtualBox Installer to make changes to your device.

VirtualBox Installer Yes

Click here if you get an error that says:

Oracle VM VirtualBox needs the Microsoft Visual C++ 2019 Redistributable Package being installed first. Please install and restart the installation of Oracle VM Virtualbox.

VirtualBox Installer Error

To fix this issue, install the appropriate package for your system from this website.

Choose the correct download link for your system. On Windows 10 you can find your system type by opening the System Information app and reading the System Type value.

System Information

System Type

Visual Package Download Page

Agree to the license terms and conditions, press Install, press Yes if prompted to allow the program to make changes to your device, and the setup should successfully complete and you can click Close.

  1. On the installation wizard popup, click "Next".

VirtualBox Wizard

  1. You may change the location for installing VirtualBox by clicking the Browse button. Then click Next.

  2. Click Yes for the Warning: Network Interfaces and Missing Dependencies Python Core / win32api sections.

  3. Click Install and wait for the installation to complete. Then click Finish.

You have now successfully installed VirtualBox.

  1. Run the VirtualBox Extension Pack that you downloaded before. Select Yes if prompted to allow VirtualBox Installer to make changes to your device.

VirtualBox Extension Pack Install

You have now successfully installed the VirtualBox Extension Pack.

📥 Download Ubuntu 22.04.2 LTS​

caution

Make sure your computer fulfills recommended system requirements for Ubuntu 22.04.2 LTS:

  • 2 GHz dual-core processor or better
  • 4 GB system memory
  • 25 GB of free hard drive space

You'll also need ~5 GB of space for the downloaded .iso file, though you can delete the file once you've fully setup the VM.

  1. Go to the Ubuntu Desktop downloads page.
  2. Download Ubuntu 22.04.2 LTS by clicking the green Download 22.04.2 button.

Ubuntu download page

🖥 Setup a Virtual Machine (VM)​

  1. Open up VirtualBox and click the New button (you can also click on the Machine menu then press New).

VirtualBox New Button

  1. On the new popup, provide a name that you'd like to identify your VM, the folder in which you'd like to install your VM, and the Ubuntu .iso file that you've downloaded. Then click Next.

VirtualBox Name &amp; OS

  1. Enter a valid username, password, hostname (this is what Ubuntu considers its name as), and enable Guest Additions along with pointing to its .iso file. Then click Next.

VirtualBox Guest OS Setup

  1. Set the Base Memory and Processors to the appropriate settings. You may have different values but a general guideline is to stay anywhere within the green section up until the border with the orange section. Generally the more you allocate, the faster the VM. Then click Next.

VirtualBox Hardware

  1. Select Create a Virtual Hard Disk Now and set a Disk Size of at least 25 GB. Then click Next.

VirtualBox Hard Disk

  1. Click Finish on the Summary page. Your VM should now be powering up and it may take a while for Ubuntu to install.

🏁 Final Steps​

  1. On your Ubuntu VM, login to your account with the username and password you set earlier.

Ubuntu Login

  1. Click Skip or Next on the top right for the welcome screen that appears (adjust any settings based on your preferences).

  2. Click Done to finish the welcome screen.

You have now successfully installed Ubuntu.

Ubuntu Desktop

✨ Bonus Tips​

  • Take a snapshot of your virtual machine now!
  • Learn more about the terminal and things to do after installing Ubuntu here.
  • You can modify the display size and other settings from the View menu option:

VirtualBox display size setting

- + \ No newline at end of file diff --git a/qsv-whirlwind-tour/index.html b/qsv-whirlwind-tour/index.html index 51b1cf2..1225c4c 100644 --- a/qsv-whirlwind-tour/index.html +++ b/qsv-whirlwind-tour/index.html @@ -4,13 +4,13 @@ 🌪 qsv Whirlwind Tour | Data Engineering Intern Onboarding Guide - +

🌪 qsv Whirlwind Tour

📺 Video Demo​

- + \ No newline at end of file diff --git a/technical-writing/daily-standups/index.html b/technical-writing/daily-standups/index.html index 0a00a29..ca76eb7 100644 --- a/technical-writing/daily-standups/index.html +++ b/technical-writing/daily-standups/index.html @@ -4,13 +4,13 @@ ☕ Daily Standups | Data Engineering Intern Onboarding Guide - +

☕ Daily Standups

You'll often greet your workday with a standup meeting. This is a meeting where you and your team members share what you've accomplished since the last standup meeting, what you plan to work on next, and any blockers you're facing.

To stay on track on a daily basis, it can be very helpful to organize yourself before, during, and after this meeting.

🏁 Before the Standup​

Try to write down the following before your standup meeting:

  • 🎉 What you've accomplished since the last standup meeting
  • 🛠 What you plan to continue working on or work on next
  • ❌ "Blockers" you are facing, which are things that stop you from continuing work on a task or project
  • ❓ Questions you have for any team member (or in general) that you couldn't get answered over your team communication platform

🏎 During the Standup​

When it's your turn, cover the points you wrote down without going into too much extensive detail (as you should put any extra details in your notes or kanban board). Ask to setup a meeting with any team member you have questions for if you can't get them answered during the standup or if what you're working on requires more discussion and doesn't need the entire team's attention.

Also make sure to write down any new tasks or to-dos assigned to you during the standup. 📃

🏆 After the Standup​

Review what you've written down and make sure you've answered all your questions and resolved any blockers. If you haven't, make sure to follow up with the appropriate team members. If you use a kanban board or any tracker for your tasks and projects, add any new tasks assigned to you to your board and update any notes or progress you've made on your tasks.

Now you have a good idea of what you need to do for the day. Get to work! 💼

🧩 Daily Standup Notes Template​

Here's a Markdown template you can use daily to keep track of your standup notes:

# 📅 [Date] Daily Standup

## 🎉 Accomplished

> What tasks you've completed or goals you've accomplished or made progress on.

-

## 🛠 Working On

> What you are currently working on or plan to start working on and how much progress you expect to make. Also when you complete or make progress on your tasks, write down what you've done for tomorrow's Accomplished section.

-

## ❌ Blockers

> Problems you're facing that stop you from continuing work.

-

## ❓ Questions

> Any specific questions you have for any team member or in general. Make sure you write down the answers when you get them too.

-

## 📃 Todo

> Any new tasks assigned, meetings to setup, etc. that you may also add to your kanban board.

- [ ]

Personally I like to use Obsidian to keep track of my daily standup notes (especially with its Daily Notes plugin), but you can use any note-taking app you like.

- + \ No newline at end of file diff --git a/technical-writing/kanban-boards/index.html b/technical-writing/kanban-boards/index.html index f38caee..fead72d 100644 --- a/technical-writing/kanban-boards/index.html +++ b/technical-writing/kanban-boards/index.html @@ -4,13 +4,13 @@ 🛹 Kanban Boards | Data Engineering Intern Onboarding Guide - +

🛹 Kanban Boards

A kanban board is a great way to organize your tasks and projects.

Kanban boards help organize your work and keep track of what you need to do, and it can be helpful to share a kanban board with your team so everyone understands what everyone else is working on and can potentially collaborate or help each other out.

There's a project management approach called Agile that can often be used in conjunction with kanban boards.

🎈 Kanban Board Example​

Here's an example of a Kanban board that keeps track of a team's tasks using Notion:

Kanban board exampleKanban board example

🏗 Kanban Board Structure​

📊 Columns​

A kanban board is comprised of columns that represent the status of a card. For example, a common kanban board has columns for Not Started, In Progress, and Done.

💳 Cards​

Within each column are cards that represent a task or project. These cards can be moved across columns to represent their status.

You may assign a card to a team member and set a due date, a priority, the estimated amount of effort to complete the task, and more. Some tools allow you to write notes in your cards, which can help organize your research and also get others up to speed on what you're working on.

🧩 Card Template​

Here's a Markdown template you can use for your kanban cards:

## 🗺 Overview

## 📌 Tasks

- [ ]

## ❌ Blockers

-

## 🔍 Notes & Research

-

## 💡 Ideas

-

## ✨ Resources & References

-

🛠 Tools & Software​

There are many tools you can use to work with a kanban board. Here are some common ones:

- + \ No newline at end of file diff --git a/technical-writing/markdown/index.html b/technical-writing/markdown/index.html index 019e2a6..a6f43cd 100644 --- a/technical-writing/markdown/index.html +++ b/technical-writing/markdown/index.html @@ -4,13 +4,13 @@ 📝 Markdown | Data Engineering Intern Onboarding Guide - +

📝 Markdown

Markdown is a markup language that is very useful for taking notes and writing documentation.

In fact, the page you're reading right now is built based on Markdown!

📚 Markdown Resources​

🏫 Learn Markdown​

📓 Markdown Editors​

Here are some Markdown editors you can use for taking notes:

note

These programs often have extra features that can be useful for taking notes, such as the ability to create kanban boards, embed images, and more. However, they do support Markdown. Also, you can instead make a new Markdown file in your favorite text editor like Visual Studio Code by saving a file with the .md extension.

- + \ No newline at end of file diff --git a/technical-writing/technical-writing-overview/index.html b/technical-writing/technical-writing-overview/index.html index 0fbd3f6..20b6ce1 100644 --- a/technical-writing/technical-writing-overview/index.html +++ b/technical-writing/technical-writing-overview/index.html @@ -3,14 +3,14 @@ -🗺 Technical Writing Overview | Data Engineering Intern Onboarding Guide - +🗺 Technical Writing Overview | Data Engineering Intern Onboarding Guide +
-

🗺 Technical Writing Overview

Though programming is a large part of software development, it's not the only part. In fact, it can become a small part. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through technical writing.

💭 Why Learn About Technical Writing?​

Technical writing offers several benefits that can enhance your professional communication skills and help others make sense of your work, be it a codebase, a project, or any other technical subject.

Here are some benefits of technical writing:

✅ Clear communication​

Technical writing isn't about using overly complex language that just ends up being difficult to understand. It's about taking complex information and conveying them in a clear and concise manner.

👔 Professional documentation​

Technical writing can help you create professional documentation for your projects, which can help others understand your work and potentially contribute to it. Writing professional reports, proposals, presentations, and more in an organized manner can enhance your professional credibility and communication skills.

👍 User-friendly content​

Understanding your audience and what their needs, preferences, and level of expertise can help you create content that is easy to understand and accessible. This can be very helpful for creating user-friendly documentation, such as tutorials, guides, and manuals.

🛠 Maintainable projects​

Just like building furniture without instructions can be like a nightmare, working and maintaining a project without documentation can be like a nightmare. Technical writing can help you share documentation that can help you and others maintain your projects and codebases.

🚀 Improvement & collaboration​

Sharing your work with others can help you get valuable feedback from your audience to improve your work, while also allowing others to learn from your work and potentially contribute to it.

📝 Where Can I Practice Technical Writing?​

You can practice technical writing in many different scenarios, such as:

🔍 Where Can I Learn More?​

Practicing technical writing while getting feedback from others is a great way to learn where you can improve.

If you'd like to take courses on technical writing, here are a few technical writing courses from Google that you can take for free:

CourseSummary
Technical Writing OneLearn the critical basics of technical writing. Take this course before taking any of the other courses.
Technical Writing TwoPractice four intermediate topics in technical writing.
Writing Helpful Error MessagesWrite clearer, more effective error messages, whether they appear in IDEs, command lines, or GUIs.

I suggest adding course recommendations to your kanban board and updating your progress as you go through them.

More importantly however, I suggest practicing technical writing in various scenarios and getting feedback from others.

- +

🗺 Technical Writing Overview

Though using a programming language may be important for your projects, communicating effectively is crucial for documenting your work. You may spend a lot more time on planning, organizing, and writing technical documentation. We'll cover some tips and tricks that may help you communicate your ideas clearly and effectively through technical writing.

💭 Why Learn About Technical Writing?​

Technical writing offers several benefits that can enhance your professional communication skills and help others make sense of your work, be it a codebase, a project, or any other technical subject.

Here are some benefits of technical writing:

✅ Clear communication​

Technical writing isn't about using overly complex language that just ends up being difficult to understand. It's about taking complex information and conveying them in a clear and concise manner.

👔 Professional documentation​

Technical writing can help you create professional documentation for your projects, which can help others understand your work and potentially contribute to it. Writing professional reports, proposals, presentations, and more in an organized manner can enhance your professional credibility and communication skills.

👍 User-friendly content​

Understanding your audience and what their needs, preferences, and level of expertise can help you create content that is easy to understand and accessible. This can be very helpful for creating user-friendly documentation, such as tutorials, guides, and manuals.

🛠 Maintainable projects​

Just like building furniture without instructions can be like a nightmare, working and maintaining a project without documentation can be like a nightmare. Technical writing can help you share documentation that can help you and others maintain your projects and codebases.

🚀 Improvement & collaboration​

Sharing your work with others can help you get valuable feedback from your audience to improve your work, while also allowing others to learn from your work and potentially contribute to it.

📝 Where Can I Practice Technical Writing?​

You can practice technical writing in many different scenarios, such as:

🔍 Where Can I Learn More?​

Practicing technical writing while getting feedback from others is a great way to learn where you can improve.

If you'd like to take courses on technical writing, here are a few technical writing courses from Google that you can take for free:

CourseSummary
Technical Writing OneLearn the critical basics of technical writing. Take this course before taking any of the other courses.
Technical Writing TwoPractice four intermediate topics in technical writing.
Writing Helpful Error MessagesWrite clearer, more effective error messages, whether they appear in IDEs, command lines, or GUIs.

I suggest adding course recommendations to your kanban board and updating your progress as you go through them.

More importantly however, I suggest practicing technical writing in various scenarios and getting feedback from others.

+ \ No newline at end of file