Legesher Docs

The Legesher Pride

Welcome to the Legesher Pride! Here, you'll find comprehensive guides and documentation to help you start working with Legesher as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Let's Get It Started

The best place to start is to evaluate what exactly you have in your toolbox and what else you need to obtain. In this lesson, we'll walk through a few key tools that are essential to contributing to Legesher: Discord, a Github account and a text editor (Atom). Allow me to explain!

In this guide, you have 4 steps to complete (denoted by the green callout boxes).

  • Join the Community
  • Create a Github User Account
  • Complete the Hello World Tutorial
  • Download Atom

The Pride

Pride - A community of ostriches

Community is extremely important to us, and having a designated space for all of us to connect and challenge each other as we share our gifts is what Discord provides us.

Discord - Communication platform built to create and foster a strong, inspiring community

Getting Connected

Join the Community

Get all set up in Discord and interact with all members of our pride. Ask questions, post updates, and share your amazing ideas.

Welcome to the Pride, click here to enter! This link will take you to this page. Discord is similar to any other communication platform - like Slack or Cisco Spark, but allows us to focus on a key feature we love within the Legesher community - our voice.

Navigating The Community

You can either open Discord up in the browser using their web application or you can download the desktop app (recommended) to access the community. Once you've given us a name to call you by, you will see this page.

On Discord, you'll be able to connect with other inspiring individuals like yourself as you contribute towards Legesher.
:one+: Introduce yourself on the #introductions channel
:two+: Check out our community guidelines
:three+: Learn how to contribute to Legesher

After you accept the invitation to join Legesher's Discord Community, you are essentially adding the Legesher server to your Discord account. The far left-hand column contains all of the servers you as a user are connected to.

The column next to the server list contains all of the channels within a specific server. You start with being in the #Welcome channel.

  • #introductions: place to connect with other members of the pride.
  • #announcements: place where major updates will be communicated.

Every channel has a short description that details the manner of the conversation within that specific channel. If you have questions regarding a specific part of the project, finding the channel that relates would be the best place to ask it!

The Code

Obviously, a very important aspect of Legesher is the code itself. Whether you are wanting to contribute as an experienced developer or writer or marketer, we want the code to excite you and not bring you anxiety. Allow us to explain further with one of the tools you will come to love!

What is Github

Github - a system that uses git, a version control software so you can version, share, collaborate and deploy code.

TONS of buzz words there ^, so let's break it down!

Github is like a social media platform for developers. Instead of posting photos, you’re posting your coding projects. You can “like” other’s projects :star+: and follow other people to stay updated with their work. You can “repost” projects and add your own twist to them by forking :fork-and-knife+:.

Github is also like Google Drive, where it hosts all of the content and assets for your projects in larger files called repositories. A repository has all of the code, images, assets, etc. needed for a particular project. Github has it's own version of "revision history" to trace back what a specific document / project looked like at a specific moment in time. You hit save or commit to create a checkpoint in your project to reference back to.

Git is the version control software that Github uses to keep track of what is happening to your coding projects.

What does version control mean?
Anytime you work in your project, anytime you save a change (in git we call that committing a change), you’re able to go back to that “snapshot” of the project and restart from there if you find yourself in a pigeon hole. Just like if checkpoints in video games, if you fail a challenge you can restart at the checkpoint. Best thing about git, is that you can create checkpoints whenever and however often you want!

Why use a version control software?
I put every project on github, because you can never predict when your laptop is going to crash/get stolen and you don’t want to lose all the work you’ve done. In college, I started writing my essays in google drive so I can work anywhere and the auto-saves literally save my butt anytime my computer crashed. (And now, google drive has “revision history” so its now even a little more like git)

With a version control software you are able to work anywhere, with anyone, at anytime. Pretty cool, huh?

Creating a Github Account

Create a Github User Account

Join the community of developers, writers, designers, etc. who have contributed to the world of open source and to Legesher. Create a user account to give your gift! :gift+:

:one+: Navigate to Github to create a new account. Enter your desired username, associated email address and secret password.

:two+: Verify your not a robot :robot: by going through the exercise.

:three+: Once verified human, select your subscription (free is more than fine for now). You don't need to select the Help me set up an organization next for you will be contributing to the Legesher organization's repositories to start!

:four+: Feel free to skip this step, but this is a survey for Github to understand your motivation for creating an account.

:five+: You will then need to verify your email address to finish setting up your account. (Also, feel free to email legsher@gmail.com for questions, concerns, or funny memes.)

:six+: After you verified your account, you can access your profile. This is where other developers can see what you've been working on and connect with you.

You repositories will be available to view here (unless they are private repositories, then they will only be visible to you).

This is for larger, overarching initiatives that belong to a project.

Stars :star+:
If you come across a repository that you think is awesome, you want to refer to later on, or any other reason - give it a star :star+:! This encourages the developer(s) working on it that you see their work, and allows you to come back to the repository later on.

Just like any other basic social media platform, you are given the ability to follow and be followed by others.

:seven+: Let's dive into Legesher and how to contribute! Feel free to star any (or all lol) of these repositories and follow any of our team members because they're inspiring people just like you!

Hello World

In computer science, the Hello World :wave+: :earth-asia+: program is the entry point to any new technology. If you can learn how to do the most simple of things right first, the rest will fall in line. You’ll be able to connect the dots and build upon the knowledge and skillset you already have. :wrench+:

Complete the Hello World Tutorial

There’s no need to reinvent the wheel :ferris-wheel+:, when the wheel is performing well. Go through Github’s tutorial on how to get started in github before going onto the next lesson.

The Platform

Text Editor - interface that allows you to open and edit your code in an user-friendly environment

Text editors can do a number of amazing things for your code - including autocorrect and color formatting. Great text editors keep tract of key words and variables that you set, so you spend less time searching and debugging your code and more time implementing your solution. At this time, we are only actively working on extensions for Atom.

Download Atom

You'll need the right tools to contribute and see your amazing work with Legseher. Download Atom and let's get to it!

The text editor is a foundational element for the Legesher project. The syntax highlighting of keywords is a key element to the success of our code.

Introduction to Atom (Text Editor)

In the Atom text editor, you can add packages to enhance the capabilities of the editor. This is where many of the legesher packages will be made available / what we will be building off of. For example, on the image above you can see the language-legesher-python package installed and enabled on my editor.

Let's Get It Started

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.