diff --git a/404.html b/404.html index 8f22964..a924de1 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ Page Not Found | SEF Handbook - +
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 d3eb6c3..0d600e3 100644 --- a/about/index.html +++ b/about/index.html @@ -4,7 +4,7 @@ About SEF | SEF Handbook - + @@ -32,7 +32,7 @@ the United Nations’ sustainable development goal of “Quality Education”. You can visit our Facebook page to see our hub of activity and our website for more details.

- + \ No newline at end of file diff --git a/assets/js/7ddb00ed.9271ef4b.js b/assets/js/7ddb00ed.9271ef4b.js deleted file mode 100644 index ab5b238..0000000 --- a/assets/js/7ddb00ed.9271ef4b.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunksef_handbook=self.webpackChunksef_handbook||[]).push([[465],{3905:(e,t,o)=>{o.d(t,{Zo:()=>p,kt:()=>m});var r=o(7294);function n(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function i(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,r)}return o}function a(e){for(var t=1;t=0||(n[o]=e[o]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(n[o]=e[o])}return n}var l=r.createContext({}),u=function(e){var t=r.useContext(l),o=t;return e&&(o="function"==typeof e?e(t):a(a({},t),e)),o},p=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var o=e.components,n=e.mdxType,i=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=u(o),m=n,g=d["".concat(l,".").concat(m)]||d[m]||c[m]||i;return o?r.createElement(g,a(a({ref:t},p),{},{components:o})):r.createElement(g,a({ref:t},p))}));function m(e,t){var o=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=o.length,a=new Array(i);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:n,a[1]=s;for(var u=2;u{o.r(t),o.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>i,metadata:()=>s,toc:()=>u});var r=o(7462),n=(o(7294),o(3905));const i={sidebar_position:11,title:"GSoC - Guidelines"},a="Google Summer of Code Contributor Guidelines",s={unversionedId:"gsoc-contributor-guidance",id:"gsoc-contributor-guidance",title:"GSoC - Guidelines",description:"Are you interested in participating in a Google Summer of Code project with SEF? We're excited to guide you toward becoming a successful GSoC contributor in our community. To assist you, we've compiled some guidelines and sessions that address your initial questions and provide insight into what is expected of students before proposal submission, after acceptance, and during the coding period.",source:"@site/docs/gsoc-contributor-guidance.md",sourceDirName:".",slug:"/gsoc-contributor-guidance",permalink:"/gsoc-contributor-guidance",draft:!1,editUrl:"https://github.com/sef-global/sef-handbook/edit/main/docs/gsoc-contributor-guidance.md",tags:[],version:"current",lastUpdatedBy:"Anjula Shanaka",lastUpdatedAt:1706748636,formattedLastUpdatedAt:"Feb 1, 2024",sidebarPosition:11,frontMatter:{sidebar_position:11,title:"GSoC - Guidelines"},sidebar:"tutorialSidebar",previous:{title:"Google Summer of Code 2024",permalink:"/project-ideas"},next:{title:"Handbook Usage",permalink:"/handbook/usage"}},l={},u=[{value:"General Guidelines",id:"general-guidelines",level:2},{value:"Before the Application",id:"before-the-application",level:4},{value:"After Being Accepted",id:"after-being-accepted",level:4},{value:"During the Coding Period",id:"during-the-coding-period",level:4},{value:"After GSoC",id:"after-gsoc",level:4},{value:"Proposal Guidelines",id:"proposal-guidelines",level:2},{value:"Awareness Sessions",id:"awareness-sessions",level:2}],p={toc:u};function c(e){let{components:t,...o}=e;return(0,n.kt)("wrapper",(0,r.Z)({},p,o,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"google-summer-of-code-contributor-guidelines"},"Google Summer of Code Contributor Guidelines"),(0,n.kt)("p",null,"Are you interested in participating in a Google Summer of Code project with SEF? We're excited to guide you toward becoming a successful GSoC contributor in our community. To assist you, we've compiled some guidelines and sessions that address your initial questions and provide insight into what is expected of students before proposal submission, after acceptance, and during the coding period."),(0,n.kt)("h2",{id:"general-guidelines"},"General Guidelines"),(0,n.kt)("h4",{id:"before-the-application"},"Before the Application"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Familiarize yourself with SEF and the project(s) you're interested in. Refer to the Developer Guide, Getting Started as a Developer, and engage with the community for any queries."),(0,n.kt)("li",{parentName:"ol"},"Explore project ideas and ask questions in the GSoC category on SEF Hive."),(0,n.kt)("li",{parentName:"ol"},"Actively participate in SEF slack channel and SEF Hive."),(0,n.kt)("li",{parentName:"ol"},"Introduce yourself on the introduction thread on SEF Hive."),(0,n.kt)("li",{parentName:"ol"},"Contribute to SEF by working on github issues. Select issues from github, work on them, and submit pull requests to the respective repository."),(0,n.kt)("li",{parentName:"ol"},"Identify potential issues in SEF projects. Create new github issues for unreported issues."),(0,n.kt)("li",{parentName:"ol"},"Increase visibility on SEF Hive and Slack by helping others and engaging in discussions."),(0,n.kt)("li",{parentName:"ol"},"Conduct code reviews. Reviewing others' code is essential for learning the SEF code base.")),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Additional Expectations:")),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Write blogs about SEF or related topics to contribute valuable information to others."),(0,n.kt)("li",{parentName:"ul"},"Properly document your work in Hive and assist others in building on it.")),(0,n.kt)("h4",{id:"after-being-accepted"},"After Being Accepted"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Set up a blog for your open source projects, including GSoC. Share the URL on SEF Hive and write weekly posts about planning and project progress during GSoC."),(0,n.kt)("li",{parentName:"ol"},"Contact your mentor immediately and establish a regular communication plan. Use slack or discussions on SEF Hive for communication."),(0,n.kt)("li",{parentName:"ol"},"CC your backup mentor in communications to keep them informed of your progress."),(0,n.kt)("li",{parentName:"ol"},"Review github issues related to your project and work on initial bugs or feature development with guidance from your mentor."),(0,n.kt)("li",{parentName:"ol"},"Prepare a detailed project plan with SMART goals and milestones, and publish it on SEF Hive.")),(0,n.kt)("h4",{id:"during-the-coding-period"},"During the Coding Period"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Submit a short weekly progress updates."),(0,n.kt)("li",{parentName:"ol"},"Write a weekly blog post to share your work publicly."),(0,n.kt)("li",{parentName:"ol"},"Commit early and often to align with our open-source community values."),(0,n.kt)("li",{parentName:"ol"},"Prepare mid-term and final project presentation videos for the community.")),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Developer Community Expectations:")),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Conduct all project-related discussions on slack or SEF Hive."),(0,n.kt)("li",{parentName:"ul"},"Ask questions in a smart way when facing challenges."),(0,n.kt)("li",{parentName:"ul"},"Participate in the weekly standup calls when your schedule allows.")),(0,n.kt)("h4",{id:"after-gsoc"},"After GSoC"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},"Write a final blog post summarizing your overall experience. Consider cross-posting to the Google Open Source Blog with approval from org admins."),(0,n.kt)("li",{parentName:"ol"},"Stay involved with your project or other projects based on your schedule."),(0,n.kt)("li",{parentName:"ol"},"Monitor SEF Hive for additional questions or feedback about your GSoC project and for other topics of interest."),(0,n.kt)("li",{parentName:"ol"},"Consider participating as a mentor for GSoC, if SEF is accepted. Your involvement will inspire secondary school students to use their programming skills in open source projects.")),(0,n.kt)("h2",{id:"proposal-guidelines"},"Proposal Guidelines"),(0,n.kt)("p",null,"You can use this as the starting point for your GSoC project proposal: ",(0,n.kt)("a",{parentName:"p",href:"https://docs.google.com/document/d/1MOQBVROS8vDh1tPg3pnxvhlYVSa9asw7Kc0B8hAnEPQ/edit?usp=sharing"},"Template")),(0,n.kt)("p",null,(0,n.kt)("strong",{parentName:"p"},"Note")," : You will submit your application through Google\u2019s website. See Google's GSoC Get Started page here: ",(0,n.kt)("a",{parentName:"p",href:"https://summerofcode.withgoogle.com/get-started/"},"https://summerofcode.withgoogle.com/get-started/")),(0,n.kt)("h2",{id:"awareness-sessions"},"Awareness Sessions"),(0,n.kt)("p",null,"We have conducted a few GSoC awareness sessions. Check out the links below:"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://www.youtube.com/live/o6rBv_5FfPo?si=CQCPvymFVX51q2DK"},"Sun's Out with Google Summer of Code 2024")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://www.youtube.com/live/2hFRHc_zNvU?si=uYzptEE-b_MU3tpu"},"Sun's Out with Google Summer of Code 2023")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://youtu.be/cso2YTD3z3s?si=nrmcT8hDKR-iwXTj"},"Google Summer of Code Awareness Session"))))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/7ddb00ed.afdcadce.js b/assets/js/7ddb00ed.afdcadce.js new file mode 100644 index 0000000..ef10974 --- /dev/null +++ b/assets/js/7ddb00ed.afdcadce.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunksef_handbook=self.webpackChunksef_handbook||[]).push([[465],{3905:(e,t,o)=>{o.d(t,{Zo:()=>p,kt:()=>m});var n=o(7294);function i(e,t,o){return t in e?Object.defineProperty(e,t,{value:o,enumerable:!0,configurable:!0,writable:!0}):e[t]=o,e}function r(e,t){var o=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),o.push.apply(o,n)}return o}function a(e){for(var t=1;t=0||(i[o]=e[o]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,o)&&(i[o]=e[o])}return i}var l=n.createContext({}),u=function(e){var t=n.useContext(l),o=t;return e&&(o="function"==typeof e?e(t):a(a({},t),e)),o},p=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},d=n.forwardRef((function(e,t){var o=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=u(o),m=i,g=d["".concat(l,".").concat(m)]||d[m]||c[m]||r;return o?n.createElement(g,a(a({ref:t},p),{},{components:o})):n.createElement(g,a({ref:t},p))}));function m(e,t){var o=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=o.length,a=new Array(r);a[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:i,a[1]=s;for(var u=2;u{o.r(t),o.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>c,frontMatter:()=>r,metadata:()=>s,toc:()=>u});var n=o(7462),i=(o(7294),o(3905));const r={sidebar_position:11,title:"GSoC - Guidelines"},a="Google Summer of Code Contributor Guidelines",s={unversionedId:"gsoc-contributor-guidance",id:"gsoc-contributor-guidance",title:"GSoC - Guidelines",description:"Are you interested in participating in a Google Summer of Code project with SEF? We're excited to guide you toward becoming a successful GSoC contributor in our community. To assist you, we've compiled some guidelines and sessions that address your initial questions and provide insight into what is expected of students before proposal submission, after acceptance, and during the coding period.",source:"@site/docs/gsoc-contributor-guidance.md",sourceDirName:".",slug:"/gsoc-contributor-guidance",permalink:"/gsoc-contributor-guidance",draft:!1,editUrl:"https://github.com/sef-global/sef-handbook/edit/main/docs/gsoc-contributor-guidance.md",tags:[],version:"current",lastUpdatedBy:"Dilini Amarasinghe",lastUpdatedAt:1708058268,formattedLastUpdatedAt:"Feb 16, 2024",sidebarPosition:11,frontMatter:{sidebar_position:11,title:"GSoC - Guidelines"},sidebar:"tutorialSidebar",previous:{title:"Google Summer of Code 2024",permalink:"/project-ideas"},next:{title:"Handbook Usage",permalink:"/handbook/usage"}},l={},u=[{value:"General Guidelines",id:"general-guidelines",level:2},{value:"Before the Application",id:"before-the-application",level:4},{value:"After Being Accepted",id:"after-being-accepted",level:4},{value:"During the Coding Period",id:"during-the-coding-period",level:4},{value:"After GSoC",id:"after-gsoc",level:4},{value:"Proposal Guidelines",id:"proposal-guidelines",level:2},{value:"Awareness Sessions",id:"awareness-sessions",level:2}],p={toc:u};function c(e){let{components:t,...o}=e;return(0,i.kt)("wrapper",(0,n.Z)({},p,o,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h1",{id:"google-summer-of-code-contributor-guidelines"},"Google Summer of Code Contributor Guidelines"),(0,i.kt)("p",null,"Are you interested in participating in a Google Summer of Code project with SEF? We're excited to guide you toward becoming a successful GSoC contributor in our community. To assist you, we've compiled some guidelines and sessions that address your initial questions and provide insight into what is expected of students before proposal submission, after acceptance, and during the coding period."),(0,i.kt)("h2",{id:"general-guidelines"},"General Guidelines"),(0,i.kt)("h4",{id:"before-the-application"},"Before the Application"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Get acquainted with SEF and your chosen projects by referring to the ",(0,i.kt)("a",{parentName:"li",href:"https://handbook.sefglobal.org/engineering-team/team"},"Getting Started")," as a Developer."),(0,i.kt)("li",{parentName:"ol"},"Initiate your involvement by asking questions and exploring project ideas on SEF Hive."),(0,i.kt)("li",{parentName:"ol"},"Active participation in the SEF Slack channel and SEF Hive is crucial for community engagement."),(0,i.kt)("li",{parentName:"ol"},"Introduce yourself in the ",(0,i.kt)("a",{parentName:"li",href:"https://sef.discourse.group/t/welcome-please-introduce-yourself/7?u=anjisvj"},"introduction")," thread on SEF Hive to connect with the community."),(0,i.kt)("li",{parentName:"ol"},"Contribute to SEF on GitHub by selecting issues, working on them, and submitting pull requests to the relevant repository."),(0,i.kt)("li",{parentName:"ol"},"Identify potential issues within SEF projects and create new GitHub issues for those that haven't been reported."),(0,i.kt)("li",{parentName:"ol"},"Boost your presence on SEF Hive and Slack by assisting others and actively participating in discussions."),(0,i.kt)("li",{parentName:"ol"},"Sharpen your understanding of the SEF code base by conducting code reviews, an essential part of the learning process.")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Additional Expectations:")),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Contribute valuable information by writing blogs about SEF or related topics."),(0,i.kt)("li",{parentName:"ul"},"Document your work thoroughly on Hive and support others in building upon it.")),(0,i.kt)("h4",{id:"after-being-accepted"},"After Being Accepted"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Establish a blog for your open source projects, including GSoC, and share the URL on SEF Hive. Provide weekly updates on planning and project progress during GSoC."),(0,i.kt)("li",{parentName:"ol"},"Initiate contact with your mentor promptly and set up a regular communication plan using Slack or SEF Hive discussions."),(0,i.kt)("li",{parentName:"ol"},"Keep your backup mentor informed of your progress by including them in communications."),(0,i.kt)("li",{parentName:"ol"},"Work on initial bugs or feature development related to your project with guidance from your mentor by reviewing GitHub issues."),(0,i.kt)("li",{parentName:"ol"},"Develop a detailed project plan with SMART goals and milestones, and share it on SEF Hive.")),(0,i.kt)("h4",{id:"during-the-coding-period"},"During the Coding Period"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Submit concise weekly progress updates."),(0,i.kt)("li",{parentName:"ol"},"Write weekly blog posts to publicly share your work."),(0,i.kt)("li",{parentName:"ol"},"Follow the open-source community values by committing early and often."),(0,i.kt)("li",{parentName:"ol"},"Prepare mid-term and final project presentation videos for the community.")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Developer Community Expectations:")),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Conduct all project-related discussions on Slack or SEF Hive."),(0,i.kt)("li",{parentName:"ul"},"Pose questions intelligently when facing challenges."),(0,i.kt)("li",{parentName:"ul"},"Participate in weekly standup calls whenever your schedule permits.")),(0,i.kt)("h4",{id:"after-gsoc"},"After GSoC"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},"Summarize your overall experience in a final blog post."),(0,i.kt)("li",{parentName:"ol"},"Stay involved with your project or other projects based on your schedule."),(0,i.kt)("li",{parentName:"ol"},"Monitor SEF Hive for additional questions or feedback about your GSoC project and other interesting topics."),(0,i.kt)("li",{parentName:"ol"},"Consider participating as a mentor for GSoC, if SEF is accepted, to inspire secondary school students to use their programming skills in open source projects.")),(0,i.kt)("h2",{id:"proposal-guidelines"},"Proposal Guidelines"),(0,i.kt)("p",null,"You can use this as the starting point for your GSoC project proposal: ",(0,i.kt)("a",{parentName:"p",href:"https://docs.google.com/document/d/1MOQBVROS8vDh1tPg3pnxvhlYVSa9asw7Kc0B8hAnEPQ/edit?usp=sharing"},"Template")),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Note")," : You will submit your application through Google\u2019s website. See Google's GSoC Get Started page here: ",(0,i.kt)("a",{parentName:"p",href:"https://summerofcode.withgoogle.com/get-started/"},"https://summerofcode.withgoogle.com/get-started/")),(0,i.kt)("h2",{id:"awareness-sessions"},"Awareness Sessions"),(0,i.kt)("p",null,"We have conducted a few GSoC awareness sessions. Check out the links below:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://www.youtube.com/live/o6rBv_5FfPo?si=CQCPvymFVX51q2DK"},"Sun's Out with Google Summer of Code 2024")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://www.youtube.com/live/2hFRHc_zNvU?si=uYzptEE-b_MU3tpu"},"Sun's Out with Google Summer of Code 2023")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("a",{parentName:"li",href:"https://youtu.be/cso2YTD3z3s?si=nrmcT8hDKR-iwXTj"},"Google Summer of Code Awareness Session"))))}c.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.8d77cfb2.js b/assets/js/runtime~main.e1a065b6.js similarity index 83% rename from assets/js/runtime~main.8d77cfb2.js rename to assets/js/runtime~main.e1a065b6.js index 816e9a1..b784240 100644 --- a/assets/js/runtime~main.8d77cfb2.js +++ b/assets/js/runtime~main.e1a065b6.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,a,o,n={},f={};function d(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,d),r.loaded=!0,r.exports}d.m=n,d.c=f,e=[],d.O=(t,r,a,o)=>{if(!r){var n=1/0;for(i=0;i=o)&&Object.keys(d.O).every((e=>d.O[e](r[c])))?r.splice(c--,1):(f=!1,o0&&e[i-1][2]>o;i--)e[i]=e[i-1];e[i]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.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);d.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,d.d(o,n),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({13:"b07f146c",51:"7a0ca49f",53:"935f2afb",220:"e566b935",268:"ca2c6532",304:"012e6a91",445:"363cede0",465:"7ddb00ed",500:"e9dd20bb",514:"1be78505",535:"3d8d21df",540:"28cbfcba",565:"1fb8c180",671:"0e384e19",730:"e485ff54",864:"ed55277e",874:"5eebbccf",918:"17896441",920:"1a4e3797",922:"a056f941"}[e]||e)+"."+{13:"f25f502c",51:"773b4bf1",53:"82549363",220:"b8523558",268:"5a88aef1",304:"304ca4b4",445:"9391803e",465:"9271ef4b",500:"de0b461e",514:"307e9af0",535:"fdb82891",540:"ec148bb9",565:"b626028d",671:"0a485eec",730:"a51ad33f",780:"872f4ed1",864:"186d927b",874:"dc78256a",894:"68d07a30",918:"6b357180",920:"03ca0a70",922:"488f4ad5",945:"033641af",972:"191f502e"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="sef-handbook:",d.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var f,c;if(void 0!==r)for(var b=document.getElementsByTagName("script"),i=0;i{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(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),c&&document.head.appendChild(f)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"918",b07f146c:"13","7a0ca49f":"51","935f2afb":"53",e566b935:"220",ca2c6532:"268","012e6a91":"304","363cede0":"445","7ddb00ed":"465",e9dd20bb:"500","1be78505":"514","3d8d21df":"535","28cbfcba":"540","1fb8c180":"565","0e384e19":"671",e485ff54:"730",ed55277e:"864","5eebbccf":"874","1a4e3797":"920",a056f941:"922"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.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=d.p+d.u(t),f=new Error;d.l(n,(r=>{if(d.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)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],f=r[1],c=r[2],b=0;if(n.some((t=>0!==e[t]))){for(a in f)d.o(f,a)&&(d.m[a]=f[a]);if(c)var i=c(d)}for(t&&t(r);b{"use strict";var e,t,r,a,o,n={},f={};function d(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,d),r.loaded=!0,r.exports}d.m=n,d.c=f,e=[],d.O=(t,r,a,o)=>{if(!r){var n=1/0;for(b=0;b=o)&&Object.keys(d.O).every((e=>d.O[e](r[c])))?r.splice(c--,1):(f=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.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);d.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,d.d(o,n),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({13:"b07f146c",51:"7a0ca49f",53:"935f2afb",220:"e566b935",268:"ca2c6532",304:"012e6a91",445:"363cede0",465:"7ddb00ed",500:"e9dd20bb",514:"1be78505",535:"3d8d21df",540:"28cbfcba",565:"1fb8c180",671:"0e384e19",730:"e485ff54",864:"ed55277e",874:"5eebbccf",918:"17896441",920:"1a4e3797",922:"a056f941"}[e]||e)+"."+{13:"f25f502c",51:"773b4bf1",53:"82549363",220:"b8523558",268:"5a88aef1",304:"304ca4b4",445:"9391803e",465:"afdcadce",500:"de0b461e",514:"307e9af0",535:"fdb82891",540:"ec148bb9",565:"b626028d",671:"0a485eec",730:"a51ad33f",780:"872f4ed1",864:"186d927b",874:"dc78256a",894:"68d07a30",918:"6b357180",920:"03ca0a70",922:"488f4ad5",945:"033641af",972:"191f502e"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="sef-handbook:",d.l=(e,t,r,n)=>{if(a[e])a[e].push(t);else{var f,c;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b{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(l.bind(null,void 0,{type:"timeout",target:f}),12e4);f.onerror=l.bind(null,f.onerror),f.onload=l.bind(null,f.onload),c&&document.head.appendChild(f)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/",d.gca=function(e){return e={17896441:"918",b07f146c:"13","7a0ca49f":"51","935f2afb":"53",e566b935:"220",ca2c6532:"268","012e6a91":"304","363cede0":"445","7ddb00ed":"465",e9dd20bb:"500","1be78505":"514","3d8d21df":"535","28cbfcba":"540","1fb8c180":"565","0e384e19":"671",e485ff54:"730",ed55277e:"864","5eebbccf":"874","1a4e3797":"920",a056f941:"922"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.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=d.p+d.u(t),f=new Error;d.l(n,(r=>{if(d.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)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,n=r[0],f=r[1],c=r[2],i=0;if(n.some((t=>0!==e[t]))){for(a in f)d.o(f,a)&&(d.m[a]=f[a]);if(c)var b=c(d)}for(t&&t(r);i Beyond 2022 | SEF Handbook - + @@ -37,7 +37,7 @@ exceptional service to their students.

In order to drive this vision we aspire to be invited to sit on secondary and tertiary education institutions Board of Directors or as Independent Consultants to influence decision making with regard to education policies and infrastructure.

- + \ No newline at end of file diff --git a/culture/self-service/index.html b/culture/self-service/index.html index 010a04b..d2d9420 100644 --- a/culture/self-service/index.html +++ b/culture/self-service/index.html @@ -4,13 +4,13 @@ Adopting a self-service and self-learning mentality | SEF Handbook - +

Adopting a self-service and self-learning mentality

Introduction​

As an all-remote organisation, SEF thrive through documentation. Importantly, this necessitates that every team member be equally invested in documenting, thereby creating a virtuous cycle of self-searching, self-service, and self-learning.

Assume your question is already answered​

It's not what you know. It's knowing where to look. This is true at SEF and other organizations that are intentional about documenting processes, and it is entirely counter to how typical work environments are structured.

From the very first day at SEF, it is imperative that new team members operate with the assumption that their questions are already answered. This is a profound process shift that may feel unnatural and inefficient.

For many — particularly team members joining from a colocated environment — this requires a retraining of sorts. You must force yourself to not default to tapping on the virtual shoulder of someone as soon as an inquiry comes to mind. Rather, team members should redirect that effort to searching.

Proactive approach to answering questions​

The Core team attempts to proactively answer any question you may have before you have to ask it. If a new hire still has a question about process that wasn't answered, the natural next step is to work with a subject matter expert at SEF to answer, then document.

Whenever a new contributor brings up a valid process point that leads to a previously undocumented answer, the default mindset should be to answer and document right away. This requires a mindset of self-service, self-searching, and self-learning. It also requires diligence and empathy.

Paying it forward​

The ideal response to learning a new answer at SEF is to document said answer in an act of paying it forward, such that every new hire that comes after will be able to find this information more quickly. Plus, it removes the companywide burden of having to develop this answer from scratch again. This mentality encompasses many sub-values.

  1. Write things down
  2. Be respectful of others' time
  3. Responsibility over rigidity
  4. Move fast by shipping the minimal viable change
  5. Ambitious
  6. Ownership
  7. Sense of urgency
  8. Bias for action

Why is self-searching and self-learning uncomfortable at first?​

For many companies, the frenetic pace of business creates a false sense of justification for bypassing documentation. Once this happens, the only way to consistently learn is to ask another person, over and over. At scale, this is an extraordinarily wasteful process that leads to exhaustion, watered-down instructions, and huge knowledge gaps as team members cycle in and out.

However, most employees are not empowered to shift an entire company culture to one that favors documentation. Thus, one typically builds a skillset of how and when to ask other humans in order to extract information vital to achieving their goals. They know it's a suboptimal approach, but may feel that they have no reasonable alternative. When you aren't given a handbook that is regularly updated and reliably actionable, it feels odd to seek answers first in documentation.

Humans tend to trust other humans more than words written in an online repository, which is why it's so vital to humanize a handbook by empowering all members of a company to contribute.

Public over private​

A commonly-rooted habit that requires breaking at SEF is this: oftentimes, people assume that by asking someone a question privately, they are doing everyone else a favor by bothering the fewest number of people.

At SEF, we flip that notion on its head. We prefer SEF Hive over private, as this enables deeper collaboration. We encourage team members to consider making private issues public wherever possible so that we can all learn from the experience, rather than requiring a small group to spend effort translating those learnings in the future.

While making conversations public may feel inefficient in the moment, it is much more efficient long-term. It leads to significantly fewer interruptions. Team members should search for their own answers, and, if an answer is not readily found or the answer is not clear, ask in public as we all should have a low level of shame. Write down any new information discovered and pay it forward so that those coming after will have better efficiency built on top of practicing collaboration, inclusion, and documenting the results.

Minimizing interruptions creates a less chaotic workplace for all, and leads to something that is increasingly precious: long, uninterrupted periods of time where you can get into a state of flow.

By answering with a link, you're doing the following:

  1. Making your day more efficient, enabling you to disengage with work earlier and enjoy your surroundings, family, and community.
  2. Allowing the recipient to ingest the answer on their own time.
  3. Removing bias from the answer, which empowers the recipient to iterate further on what is documented by starting a merge request.
  4. Leading by example, showing new team members that they too should strive to answer via documentation.
- + \ No newline at end of file diff --git a/engineering-team/team-responsibilities/index.html b/engineering-team/team-responsibilities/index.html index 8ae957e..473792f 100644 --- a/engineering-team/team-responsibilities/index.html +++ b/engineering-team/team-responsibilities/index.html @@ -4,13 +4,13 @@ Team Responsibilities | SEF Handbook - +

Team Responsibilities

Since joining the engineering team takes a considerable amount of effort and going through an evaluation process, continuing to be a part of the team would also require the same effort. Being part of the team is a rare opportunity and it is our responsibility as management to determine whether the efforts you make meet our expectations. The following points will be used to ascertain such efforts:

  • Have you been consistently participating in the standups?
    At least 8 days of participation per a time period of 3 months is considered mandatory
  • Did you keep the team updated on the days on which you were unable to participate in a standup?
    Stating the reason for absence is not mandatory, yet keeping the team updated on the status of your recent tasks is appreciated.
  • Have you led or contributed to a project feature recently?
    Proactively taking part and contributing to new features as well as leading them is a major responsibility of being part of the engineering team.
  • Were you able to meet the deadlines?
    Even though we are feature based, it is expected from a team member to complete the tasks on time. If certain circumstances are hindering your performance, please be kind enough to update the team. Therefore the task can be assigned to another team member or an extension can be granted.

Although it is not expected from you to strictly adhere to the following points, consider them as expectations of a responsible team member:

  • Following best practices when contributing
  • Keeping the team updated if you are taking a leave
  • Proactively contributing instead of waiting to be assigned to a task
  • Taking ownership when it comes to your tasks and meeting deadlines
  • Helping out your fellow colleagues
  • Communication -
    • Keep the team updated on what you are working on, either through hive posts or slack messages
    • If you are facing blockers or any issues, keep the team updated
    • Keep discussions public, since every member can chip in their thoughts
- + \ No newline at end of file diff --git a/engineering-team/team/index.html b/engineering-team/team/index.html index 7ee7f55..644b535 100644 --- a/engineering-team/team/index.html +++ b/engineering-team/team/index.html @@ -4,7 +4,7 @@ Being part of the Engineering Team | SEF Handbook - + @@ -84,7 +84,7 @@ social media profiles. For further details refer here The hierarchy of badges and the requirements are as follows:

  • Level 0 - Contributor Kraken
    • Has made the first pull request
    • Has introduced themselves on SEF Hive
  • Level 1 - Titan Developer
    • Has made three pull requests
    • Has level 0 badge
  • Level 2 - Git Gojira
    • Has made five pull requests
    • Has level 1 badge
  • Level 3 - SEF Prodigy
    • Has passed the quiz
    • Has level 2 badge
    • Will be added to the GitHub organization
  • Level 4 - Monster Volunteer
    • Has taken part in standups for one month
    • Has level 3 badge
  • Level 5 - Open Source Behemoth
    • Is a member of a sprint
    • Has level 4 badge
    • Will be added to the engineering team as a software engineer

Weekly Engineering Team Standup​

Join us for our weekly Engineering Team Standup every Saturday at 7:00 pm IST. Meeting Link: https://meet.google.com/mys-fenp-knv

- + \ No newline at end of file diff --git a/goals/index.html b/goals/index.html index 0d3e37a..008c7da 100644 --- a/goals/index.html +++ b/goals/index.html @@ -4,14 +4,14 @@ Goals | SEF Handbook - +

Goals

Our aim is to enable the Sri Lankan education system to develop into one where:

  • Knowledge is acquired via both traditional and non traditional pathways without infrastructure limitations.
  • Students graduate with in-demand employability/entrepreneurial skills.
  • Values like genuine curiosity, capability for research, social justice and ownership/responsibility are instilled in students.
  • Attitudes such as resilience, self-reliance and growth mindset are instilled from an early age in students.

In turn moving Sri Lanka from brain drain to brain gain by:

  • Breaking cultural stereotyping of careers and higher education options.
  • Connecting Sri Lankan expats with local students to broaden their career and education options.
  • Providing in demand skills to graduates that improve their employability.
- + \ No newline at end of file diff --git a/gsoc-contributor-guidance/index.html b/gsoc-contributor-guidance/index.html index 55daf2b..6bc34d3 100644 --- a/gsoc-contributor-guidance/index.html +++ b/gsoc-contributor-guidance/index.html @@ -4,13 +4,13 @@ GSoC - Guidelines | SEF Handbook - +
-

Google Summer of Code Contributor Guidelines

Are you interested in participating in a Google Summer of Code project with SEF? We're excited to guide you toward becoming a successful GSoC contributor in our community. To assist you, we've compiled some guidelines and sessions that address your initial questions and provide insight into what is expected of students before proposal submission, after acceptance, and during the coding period.

General Guidelines​

Before the Application​

  1. Familiarize yourself with SEF and the project(s) you're interested in. Refer to the Developer Guide, Getting Started as a Developer, and engage with the community for any queries.
  2. Explore project ideas and ask questions in the GSoC category on SEF Hive.
  3. Actively participate in SEF slack channel and SEF Hive.
  4. Introduce yourself on the introduction thread on SEF Hive.
  5. Contribute to SEF by working on github issues. Select issues from github, work on them, and submit pull requests to the respective repository.
  6. Identify potential issues in SEF projects. Create new github issues for unreported issues.
  7. Increase visibility on SEF Hive and Slack by helping others and engaging in discussions.
  8. Conduct code reviews. Reviewing others' code is essential for learning the SEF code base.

Additional Expectations:

  • Write blogs about SEF or related topics to contribute valuable information to others.
  • Properly document your work in Hive and assist others in building on it.

After Being Accepted​

  1. Set up a blog for your open source projects, including GSoC. Share the URL on SEF Hive and write weekly posts about planning and project progress during GSoC.
  2. Contact your mentor immediately and establish a regular communication plan. Use slack or discussions on SEF Hive for communication.
  3. CC your backup mentor in communications to keep them informed of your progress.
  4. Review github issues related to your project and work on initial bugs or feature development with guidance from your mentor.
  5. Prepare a detailed project plan with SMART goals and milestones, and publish it on SEF Hive.

During the Coding Period​

  1. Submit a short weekly progress updates.
  2. Write a weekly blog post to share your work publicly.
  3. Commit early and often to align with our open-source community values.
  4. Prepare mid-term and final project presentation videos for the community.

Developer Community Expectations:

  • Conduct all project-related discussions on slack or SEF Hive.
  • Ask questions in a smart way when facing challenges.
  • Participate in the weekly standup calls when your schedule allows.

After GSoC​

  1. Write a final blog post summarizing your overall experience. Consider cross-posting to the Google Open Source Blog with approval from org admins.
  2. Stay involved with your project or other projects based on your schedule.
  3. Monitor SEF Hive for additional questions or feedback about your GSoC project and for other topics of interest.
  4. Consider participating as a mentor for GSoC, if SEF is accepted. Your involvement will inspire secondary school students to use their programming skills in open source projects.

Proposal Guidelines​

You can use this as the starting point for your GSoC project proposal: Template

Note : You will submit your application through Google’s website. See Google's GSoC Get Started page here: https://summerofcode.withgoogle.com/get-started/

Awareness Sessions​

We have conducted a few GSoC awareness sessions. Check out the links below:

- +

Google Summer of Code Contributor Guidelines

Are you interested in participating in a Google Summer of Code project with SEF? We're excited to guide you toward becoming a successful GSoC contributor in our community. To assist you, we've compiled some guidelines and sessions that address your initial questions and provide insight into what is expected of students before proposal submission, after acceptance, and during the coding period.

General Guidelines​

Before the Application​

  1. Get acquainted with SEF and your chosen projects by referring to the Getting Started as a Developer.
  2. Initiate your involvement by asking questions and exploring project ideas on SEF Hive.
  3. Active participation in the SEF Slack channel and SEF Hive is crucial for community engagement.
  4. Introduce yourself in the introduction thread on SEF Hive to connect with the community.
  5. Contribute to SEF on GitHub by selecting issues, working on them, and submitting pull requests to the relevant repository.
  6. Identify potential issues within SEF projects and create new GitHub issues for those that haven't been reported.
  7. Boost your presence on SEF Hive and Slack by assisting others and actively participating in discussions.
  8. Sharpen your understanding of the SEF code base by conducting code reviews, an essential part of the learning process.

Additional Expectations:

  • Contribute valuable information by writing blogs about SEF or related topics.
  • Document your work thoroughly on Hive and support others in building upon it.

After Being Accepted​

  1. Establish a blog for your open source projects, including GSoC, and share the URL on SEF Hive. Provide weekly updates on planning and project progress during GSoC.
  2. Initiate contact with your mentor promptly and set up a regular communication plan using Slack or SEF Hive discussions.
  3. Keep your backup mentor informed of your progress by including them in communications.
  4. Work on initial bugs or feature development related to your project with guidance from your mentor by reviewing GitHub issues.
  5. Develop a detailed project plan with SMART goals and milestones, and share it on SEF Hive.

During the Coding Period​

  1. Submit concise weekly progress updates.
  2. Write weekly blog posts to publicly share your work.
  3. Follow the open-source community values by committing early and often.
  4. Prepare mid-term and final project presentation videos for the community.

Developer Community Expectations:

  • Conduct all project-related discussions on Slack or SEF Hive.
  • Pose questions intelligently when facing challenges.
  • Participate in weekly standup calls whenever your schedule permits.

After GSoC​

  1. Summarize your overall experience in a final blog post.
  2. Stay involved with your project or other projects based on your schedule.
  3. Monitor SEF Hive for additional questions or feedback about your GSoC project and other interesting topics.
  4. Consider participating as a mentor for GSoC, if SEF is accepted, to inspire secondary school students to use their programming skills in open source projects.

Proposal Guidelines​

You can use this as the starting point for your GSoC project proposal: Template

Note : You will submit your application through Google’s website. See Google's GSoC Get Started page here: https://summerofcode.withgoogle.com/get-started/

Awareness Sessions​

We have conducted a few GSoC awareness sessions. Check out the links below:

+ \ No newline at end of file diff --git a/handbook/edit-locally/index.html b/handbook/edit-locally/index.html index 7c9d743..19ca87f 100644 --- a/handbook/edit-locally/index.html +++ b/handbook/edit-locally/index.html @@ -4,7 +4,7 @@ Edit the handbook locally | SEF Handbook - + @@ -23,7 +23,7 @@ in markdown. Read through the Docusaurus' Markdown features guide to understand its syntax and create new content. Follow Docusaurus' Docs guide for more information on creating new pages.

7. Test if all URL links in a page are valid​

Run npm run build command on your terminal.

It will tell you how many links, if any, are invalid. Fix any invalid links and ideally any warnings.

All internal links (links leading to other parts of the website) should be relative.

Alternative method:

  1. Install the check-my-links extension in Chrome or the Broken Link Checker addon in Firefox.
  2. Open the page you wish to preview (see previous step).
  3. Click the newly installed extension in the upper right corner of Chrome.
- + \ No newline at end of file diff --git a/handbook/practical-handbook-edits/index.html b/handbook/practical-handbook-edits/index.html index 6699fe2..de5411f 100644 --- a/handbook/practical-handbook-edits/index.html +++ b/handbook/practical-handbook-edits/index.html @@ -4,7 +4,7 @@ Practical Handbook Edits | SEF Handbook - + @@ -23,7 +23,7 @@ directory of the handbook repository to get a list of all *.md files. This matches .md as suffix.

find . -type f -name '*.md'

Instead of the . you can also use a directory in the current path.

find source/handbook -type f -name '*.md'

The type f specifies files, d matches for directories. When not specified, all files and directories are taken into account. You can replace -name with -regex to do more sensitive matching, for example to match all .md and .md.erb files.

find . -type f -regex '.*\.md[.erb]*'
- + \ No newline at end of file diff --git a/handbook/usage/index.html b/handbook/usage/index.html index ac423b9..413bc04 100644 --- a/handbook/usage/index.html +++ b/handbook/usage/index.html @@ -4,7 +4,7 @@ Handbook Usage | SEF Handbook - + @@ -98,7 +98,7 @@ Simple Language.

Having Trouble Contributing to the Handbook?​

If you run into trouble editing the SEF Handbook there are various means of help available.

  • Team members, are available to help you create a pull request or debug any problems you might run into while updating the SEF Handbook.
  • For more serious problems, especially ones that are time sensitive or prohibiting access to important information, reach out to team members who are on-call to help resolve the problem.
- + \ No newline at end of file diff --git a/index.html b/index.html index b302da4..0087b83 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ Introduction | SEF Handbook - + @@ -35,7 +35,7 @@ misinterpretation. We also recognize that we have a global audience and that may bring different interpretations. If you have any questions or need further clarification please check with the content owner of the page. When in doubt please reach out and ask.

Remember that everything is in draft at SEF and subject to change, this includes our handbook.

More about the handbook​

We've gathered some information about the handbook here, but there's still more elsewhere.

Handbook usage

Practical Handbook Edits Examples

- + \ No newline at end of file diff --git a/project-ideas/index.html b/project-ideas/index.html index d9ac169..8373c36 100644 --- a/project-ideas/index.html +++ b/project-ideas/index.html @@ -4,13 +4,13 @@ Google Summer of Code 2024 | SEF Handbook - +

Google Summer of Code 2024

Sustainable Education Foundation is excited to announce our first-time application to be a mentoring organization for Google Summer of Code 2024! We are eager to be part of this esteemed program and are looking forward to the potential projects and mentorship opportunities available in 2024. Participating in Google Summer of Code with SEF provides a unique chance to enhance your coding skills while contributing to initiatives that have a positive impact on education in developing countries.

If you are new to Sustainable Education Foundation, we recommend going through our handbook.

Project Ideas​

  1. ScholarX Messaging

    • Description: The project involves creating a messaging feature for a web application to enhance communication between mentors and mentees in ScholarX. The key features expected include a user-friendly chat interface with real-time messaging, support for text messages, and possibly file attachments.
    • Skills: React, TypeScript, Node.js
    • Mentors: Kumuditha Karunarathne (Primary), Mayura Alahakoon (Secondary)
    • Rating and Size: Medium, 175 hours
    • Outcomes: Project Link

  2. Integrated Email Communication System for ScholarX Platform

    • Description: To enhance communication within the ScholarX platform, an integrated email system will be implemented. This will allow program admins to seamlessly contact mentors and mentees directly through the platform, eliminating the need for external email systems. The integration will include features such as composing, sending, and receiving emails, as well as organizing and tracking communications for monitoring purposes.
    • Skills: React, TypeScript, Node.js, Email API Integration (e.g., SMTP for sending emails, IMAP for receiving emails)
    • Mentors: Mayura Alahakoon (Primary), Heshan Jayaneththi (Secondary)
    • Rating and Size: Medium, 175 hours
    • Outcomes: Project Link

  3. Individual Profile for Mentors/Mentees

    • Description: It would be beneficial to provide ScholarX users (mentors and mentees) with a means to share their ScholarX profiles as a portfolio. This feature would enable them to showcase their activities, including past mentorships (both taken and given), reviews, and other pertinent details such as their background, skills, and experience.
    • Skills: React, TypeScript, Node.js
    • Mentors: Piumal Rathnayake (Primary), Kumuditha Karunarathne (Secondary)
    • Rating and Size: Medium, 175 hours
    • Outcomes: Project Link

  4. Integrated Appointment System for ScholarX Platform

    • Description: One of the key requirements of the ScholarX program is to understand the interactions between the mentees and the mentors. However, since most of the meeting/discussion scheduling happens outside the platform, program admins have to rely on manual feedback collections to monitor aspects like frequency of discussions, discussed topics, etc.
    • Skills: React, TypeScript, Node.js
    • Mentors: Ashen Hirantha (Primary), Anjula Samarasinghe (Secondary)
    • Rating and Size: Medium, 175 hours
    • Outcomes: Project Link

  5. ScholarX Certificate Generator

    • Description: ScholarX Certificate Generator will address the inefficiencies of the current manual system. The project is designed to streamline and enhance the certification process for the ScholarX program. This platform enables seamless certificate generation for program participants, ensuring a quick and efficient way to validate their achievements.
    • Skills: React, TypeScript, Node.js, Jest
    • Mentors: Janith Kariyawasam (Primary), Ashen Hirantha (Secondary)
    • Rating and Size: Medium, 175 hours
    • Outcomes: Project Link

  6. Recommendation System for ScholarX Platform

    • Description: Currently, in the ScholarX Platform, mentees can filter mentors by category and find a suited mentor, but we want to implement a more sophisticated recommendation system, which will analyze mentees' responses to questions to identify their interests and then match mentees with mentors based on similar interests, providing a more personalized and effective mentorship experience.
    • Skills: Understanding of machine learning algorithms for analysis, Familiarity with creating web services and APIs, Python
    • Mentors: Madhawa Monarawila (Primary), Akshika Wijesundara (Secondary)
    • Rating and Size: Medium, 175 hours
    • Outcomes: Project Link

  7. Program Progress Data Visualization for ScholarX

    • Description: We need to get some insights on what’s happening with the program. The best solution to this is to visualize the data we have in a meaningful way. We can integrate this to our existing admin dashboard. With this information we can make better decisions to make the ScholarX program better.
    • Skills: React, TypeScript, Node.js
    • Mentors: Anjula Samarasinghe (Primary), Madhawa Monarawila (Secondary)
    • Rating and Size: Medium, 175 hours
    • Outcomes: Project Link

Guidelines​

Connect with us​

- + \ No newline at end of file diff --git a/search/index.html b/search/index.html index bfe9e32..7233be6 100644 --- a/search/index.html +++ b/search/index.html @@ -4,13 +4,13 @@ Search the documentation | SEF Handbook - +

Search the documentation

- + \ No newline at end of file diff --git a/what-we-do/index.html b/what-we-do/index.html index 4efe065..07f4f3b 100644 --- a/what-we-do/index.html +++ b/what-we-do/index.html @@ -4,7 +4,7 @@ What we do | SEF Handbook - + @@ -45,7 +45,7 @@ event, allowing students from anywhere in Sri Lanka and the world to interact with the speakers in real time.

Through OneLive, we have managed to invite Sri Lankans from Fortune500 companies like Google, Apple etc.: and Sri Lankans from top Universities in the world (including University of Stanford, University of Princeton etc.:)

We have conducted 50+ OneLives so far, with 250,000+ unique viewers in aggregate. Check appendix for the full list of OneLives.

- + \ No newline at end of file diff --git a/why-partner-with-us/index.html b/why-partner-with-us/index.html index cadd771..9c99a72 100644 --- a/why-partner-with-us/index.html +++ b/why-partner-with-us/index.html @@ -4,7 +4,7 @@ Why do you need to partner with us | SEF Handbook - + @@ -15,7 +15,7 @@ international experiences are combined with the right infrastructure, governance and delivery mechanisms.

We have no political affiliations or gains, and we are only driven purely to build the education system in Sri Lanka. We only seek to work with other organisations and individuals who align with our values and purpose to enable the future generations of Sri Lanka to thrive.

- + \ No newline at end of file