Giter VIP home page Giter VIP logo

patriba / people Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sswconsulting/ssw.people.profiles

0.0 0.0 0.0 22.73 MB

At SSW, we work together to form an amazing collective brain​​ - ​SSW is made up of a great team of staff that are passionate about technology and how it meets business needs! We're enthusiastic and have a "Make it happen" culture.

Home Page: https://www.ssw.com.au/people/

people's Introduction

People

Welcome to People.SSW ! All SSW Profiles have been automatically migrated from our previous iteration (hosted on SharePoint) and therefore might not be optimized. Please, feel free to fix typos and styling mistakes.

These markdown files are used by our Gatsby static site generator to generate https://people.ssw.com.au/

Gatsby generator project: https://github.com/SSWConsulting/people.ssw.com.au/

Sample Profile: https://www.ssw.com.au/people/bob-northwind

Instructions

How to create a new profile

  1. In CRM, ensure that you have an user profile or create user profile in CRM - https://live.crm.ssw.com.au/main.aspx#

Instructions_CRM_Users.png
Figure: Find your user profile in CRM

If your name is not in the list click in + New

Instructions_Create_User_CRM.png
Figure: Add New

  1. Fork the repository SSWConsulting/People - Branch: master

Instructions_Fork_Repository.png
Figure: Fork the Repository to be able to create a new profile

  1. Clone your forked repository

Hint: You can use GitHub Desktop

Instructions_Clone_Forked_Repository.png
Figure: Clone the forked repository to start to create a new profile

  1. In Windows Explorer, Copy & Paste "Bob Northwind" Profile folder

Instructions_Copy_Paste_Folder.png
Figure: Copy & Paste "Bob Northwind" folder

  1. Change folder and file names to match user’s Firstname-Lastname identifier
    • Firstname-Lastname must be identical to CRM data

Instructions_Change_Folder_Name.png
Figure: Change folder's name from "Bob-Northwind" to "Firstname-Lastname"

Instructions_Change_File_Names.png
Figure: Change profile file's name from "Bob-Northwind" to "Firstname-Lastname"

Instructions_Change_Image_Name.png
Figure: Replace the profile images from "Bob-Northwind" to "Firstname-Lastname"

  1. Open Firstname-Lastname.md file and update profile information

Instructions_Change_File_Names.png
Figure: Open & Update profile file

  • If you want to include badges to your profile, look for the image in the /badges folder
  • If you want to add images or your badge is not in the /badges folder, follow the instruction in How to add images on GitHub section
  1. Commit your changes

Instructions_Commit_Push_Changes.png
Figure: Commit your changes

  1. Create Pull Request and you are done
    Follow instructions in the step 5 in How to publish your changes section

TODO: Improve user experience (automation)

How to edit your profile on GitHub

  1. Find your folder from the root
  2. Navigate to [Firstname]-[Lastname].md
  3. Make your changes

Hint: you can use https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet if you are not familiar with Markdown

Important: Do not modify your name, it needs to match your name in CRM

How to add images on GitHub

If the image you want to use exist in the '/badges' folder:

  1. Reference the images in your Bio using ![The figure caption](../badges/XXX.png)

If the image you want to use doesn't exist in the '/badges' folder:

  1. Navigate to your profile folder
  2. Navigate to /People/[Firstname]-[Lastname]/Images/Bio

Instructions_Upload_Images.jpg Figure: Uploading new files

  1. Reference the images in your Bio using ![The figure caption](./Images/Bio/XXX.png)

Important:

  • Avoid spaces in filenames, use hyphens instead
  • Upload images with a width of at least 135px

Set images sizes

Our Markdown processor uses custom Markups to extend markdown capabilities on image styling. Images added to your profile can be defined as :

  • "Badge" - inline fixed 135px maximum width
  • "Small" - fixed 200px maximum width
  • "Medium" - fixed 400px maximum width
  • "Large" - no maximum width

To assign one those predefined styles to an image, use the following syntax:

[[Custom_Style_Code]]
| ![The figure caption](./Images/Bio/XXX.png)

Example:

[[imgBadge]]
| ![Angular logo](./Images/Bio/angular.png)

Available styles :

Style name Code Inline Image max-width Caption
Badge imgBadge true 135px false
Small imgSm false 200px true
Medium imgMd false 400px true
Large imgLg false none true

How to publish your changes

  1. Navigate to your markdown profile
  2. Click "Edit"

Instructions_Click_Edit.jpg Figure: Enabling edit mode in GitHub

  1. Make your changes
  2. Click "Propose File Change"

Important: Please add a description for your changes so reviewers have context when approving your changes

Instructions_Save_Changes.png Figure: Saving changes

  1. Click "Create Pull Request"

Instructions_Create_PR.png Figure: Creating pull request (PR)

people's People

Contributors

tiagov8 avatar uly1 avatar jeanthirion avatar patriba avatar sebastienboissiere avatar sswrebeccaliu avatar camillars avatar wicksipedia avatar pennywalker avatar jernejk avatar gabrielgeorge avatar miichaelsmedley avatar andreaslengkeek avatar stephencarterssw avatar christoment avatar ankyche avatar premradhakrishnan avatar stansidik avatar apforsyth avatar alvinshenssw avatar brittanylawrencessw avatar matthewsampiasssw avatar patriciabarrosssw avatar kikibianc avatar william-liebenberg avatar ozdemir-mehmet avatar gregharrisssw avatar duncanstark avatar alexbreskin avatar ulyssesmaclaren avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.