Skip to content

Commit

Permalink
finished up docs
Browse files Browse the repository at this point in the history
Signed-off-by: Frances Coronel <[email protected]>
  • Loading branch information
FrancesCoronel committed Aug 24, 2023
1 parent 95b1db0 commit 43adcfd
Show file tree
Hide file tree
Showing 12 changed files with 176 additions and 84 deletions.
2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [hello@francescoronel.com](mailto:hello@francescoronel.com). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [hello@latina.dev](mailto:hello@latina.dev). The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2016-2023 Frances Coronel
Copyright (c) 2023 Latina Dev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
82 changes: 5 additions & 77 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ Latina Dev is an open-source directory of Latina software engineers at the stude

Our goal is to increase visibility and access to valuable opportunities.

[![GitHub Issues](https://img.shields.io/github/issues/Latina-Dev/latina-dev.svg?style=for-the-badge)](https://github.com/Latina-Dev/latina-dev/issues) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/Latina-Dev/latina-dev.svg?style=for-the-badge)](https://github.com/Latina-Dev/latina-dev/pulls)
[![GitHub Issues](https://img.shields.io/github/issues/Latina-Dev/latina-dev.svg?style=for-the-badge)](https://github.com/Latina-Dev/latina-dev/issues) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/Latina-Dev/latina-dev.svg?style=for-the-badge)](https://github.com/Latina-Dev/latina-dev/pulls)

[![LinkedIn](https://img.shields.io/badge/-LinkedIn-0e76a8?style=for-the-badge&logo=Linkedin&logoColor=white)](https://linkedin.com/company/latina-dev) [![Discord Latina Dev Community](https://dcbadge.vercel.app/api/server/xzHDhxsQAQ)](https://discord.gg/xzHDhxsQAQ) [![Follow on GitHub](https://img.shields.io/github/followers/Latina-Dev?logo=github&style=for-the-badge&color=black)](https://github.com/Latina-Dev?tab=followers)
[![Discord Latina Dev Community](https://dcbadge.vercel.app/api/server/xzHDhxsQAQ)](https://discord.gg/xzHDhxsQAQ) [![Follow on GitHub](https://img.shields.io/github/followers/Latina-Dev?logo=github&style=for-the-badge&color=black)](https://github.com/Latina-Dev?tab=followers) [![LinkedIn](https://img.shields.io/badge/-LinkedIn-0e76a8?style=for-the-badge&logo=Linkedin&logoColor=white)](https://linkedin.com/company/latina-dev)

[![Vercel](https://therealsujitk-vercel-badge.vercel.app/?app=Latina-Dev&style=for-the-badge)](https://vercel.com/latina-dev/latina-dev) [![MIT License](https://img.shields.io/github/license/Latina-Dev/latina-dev.svg?style=for-the-badge)](http://badges.mit-license.org)

🌐 [Website](https://latina.dev)

💼 [LinkedIn Page](https://linkedin.com/company/latina-dev)

📚 [Documentation](https://latina.dev/docs)

👾 [Discord](https://discord.gg/xzHDhxsQAQ)

🎨 [Storybook](https://www.chromatic.com/library?appId=6472ce8643c60096810af8c0)
Expand All @@ -38,84 +40,10 @@ Our goal is to increase visibility and access to valuable opportunities.

Or just [create an issue](https://github.com/Latina-Dev/latina-dev/issues/new/choose) - any little bit of help counts! 😊

## Overview

### Vision

Amplify opportunities for over 1,000 Latina software engineers by 2025.

### Timeline

- the idea started in October 2022
- initial website launched January 2023
- first MVP launched June 2023
- targeting October 2023 for user auth + database

## Member Levels

This is how we categorize members so we can match them with the right opportunities.

### Student

- You are currently enrolled in a degree program or a coding bootcamp
- e.g., bootcamp student, a computer science student, self-taught

### Individual Contributor

- You are currently or were recently employed as a software engineer
- Or you are a recent graduate and are actively looking for a job
- e.g., fullstack engineer, developer advocate, data scientist

### Leader

- You are currently or were recently employed as a manager, director, or executive
- e.g., engineering manager, CTO, technical founder

## Adding a New Member

There should be **two changes** in the PR you open, one for the Markdown file and the other for the image.

### Markdown File

#### 1. Add a new file to the `data/members` directory with the following format: `firstname-lastname.md`.

#### 2. You can use the template below to get started:

```md
---
name: Frances Coronel // first and last name
added: "2023-01-25" // date you were added
level: "Individual Contributor" // see member levels for more info
linkedin: "francescoronel" // your LinkedIn handle
countries: ["Peru"] // your country or coutries of origin
---
```

There are various **optional** fields that you can add as well.

```md
---
github: "FrancesCoronel" // your GitHub handle
twitter: "FrancesCoronel" // your Twitter handle
website: "https://francescoronel.com" // your personal website
affiliation: "Senior Software Engineer at XYZ" // your current title and org
---

Brief bio about yourself. You can use Markdown here.
```

### Image

#### 3. Add an image of yourself in the `public/img/members` folder

- the image must be at least 250px by 250px
- the image must have the same width and height
- the image must have the same name as the file you created in step 1, formatted as `firstname-lastname.jpg`

## Contributors

<a href="https://github.com/Latina-Dev/latina-dev/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Latina-Dev/latina-dev" />
</a>

[![Powered by Vercel](/public/img/logos/vercel.svg "Vercel")](https://vercel.com?utm_source=latina-dev&utm_campaign=oss)
[![Powered by Vercel](https://latina.dev/img/logos/vercel.svg "Vercel")](https://vercel.com?utm_source=latina-dev&utm_campaign=oss)
2 changes: 1 addition & 1 deletion components/Homepage/Hero/Hero.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default function Hero() {
</div>
<ButtonLink
text="Contribute on GitHub"
url="https://github.com/FrancesCoronel/latina-dev"
url="https://github.com/Latina-Dev/latina-dev"
external={true}
icon={faGithub}
/>
Expand Down
Empty file added docs/.nojekyll
Empty file.
5 changes: 5 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- [Home 🏠](/README)
- [Overview](/pages/overview)
- [Branding](/pages/branding)
- [Adding a Member](/pages/adding-a-member)
- [Member Levels](/pages/member-levels)
92 changes: 92 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<title>Latina Dev</title>
<!-- Meta Tags -->
<meta name="description" content="Latina Dev is an open-source directory of Latina software engineers.">
<meta name="keywords" content="latina, software engineer, community">
<!-- CSS -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
<!-- Favicons -->
<link rel="shortcut icon" href="https://latina.dev/img/favicons/favicon.ico" />
<link rel="icon" type="image/x-icon" sizes="16x16 32x32" href="https://latina.dev/img/favicons/favicon.ico">
<link rel="icon" sizes="192x192" href="https://latina.dev/img/favicons/favicon-192.png">
<link rel="apple-touch-icon-precomposed" sizes="180x180" href="https://latina.dev/img/favicons/favicon-180.png">
<meta name="msapplication-TileColor" content="#9e0001">
<meta name="msapplication-TileImage" content="https://latina.dev/img/favicons/favicon-144.png">
<!-- Open Graph -->
<meta property="og:url" content="https://latina.dev">
<meta property="og:type" content="website">
<meta property="og:title" content="Latina Dev">
<meta property="og:image" content="https://latina.dev/img/featured-image.png">
<meta property="og:description" content="Latina Dev is an open-source directory of Latina software engineers.">
<meta property="og:site_name" content="Latina Dev">
<meta property="og:locale" content="en_US">
<meta property="article:author" content="Latina Dev">
<style>
body {
font-size: 1rem;
}

pre:after {
padding: 1em;
right: .5em;
}

nav.app-nav li ul {
min-width: 100px;
}

.sidebar ul li a {
white-space: pre-line;
padding-right: .5em;
}

.markdown-section {
max-width: 90%;
}

.markdown-section code {
font-size: inherit;
}

.markdown-section pre>code {
white-space: pre-wrap;
}

.markdown-section ol,
.markdown-section ul {
margin: 0;
}
</style>
</head>

<body>
<div id="app">One sec... 🦉</div>
</body>
<!-- Config -->
<script>
window.$docsify = {
auto2top: true,
executeScript: true,
loadSidebar: true,
homepage: 'https://raw.githubusercontent.com/Latina-Dev/latina-dev/main/README.md',
name: 'Latina Dev',
search: {
paths: 'auto',
placeholder: 'Type to search 🔍',
noData: 'No Results! 🦉',
}
};
</script>
<!-- Docsify -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4"></script>
<!-- Plugins -->
<script src="https://unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="https://unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script src="https://unpkg.com/docsify/lib/plugins/zoom-image.min.js"></script>

</html>
40 changes: 40 additions & 0 deletions docs/pages/adding-a-member.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Adding a New Member

There should be **two changes** in the PR you open, one for the Markdown file and the other for the image.

## Markdown File

### 1. Add a new file to the `data/members` directory with the following format: `firstname-lastname.md`.

### 2. You can use the template below to get started:

```md
---
name: Frances Coronel // first and last name
added: "2023-01-25" // date you were added
level: "Individual Contributor" // see member levels for more info
linkedin: "francescoronel" // your LinkedIn handle
countries: ["Peru"] // your country or coutries of origin
---
```

There are various **optional** fields that you can add as well.

```md
---
github: "FrancesCoronel" // your GitHub handle
twitter: "FrancesCoronel" // your Twitter handle
website: "https://francescoronel.com" // your personal website
affiliation: "Senior Software Engineer at XYZ" // your current title and org
---

Brief bio about yourself. You can use Markdown here.
```

## Image

### 3. Add an image of yourself in the `public/img/members` folder

- the image must be at least 250px by 250px
- the image must have the same width and height
- the image must have the same name as the file you created in step 1, formatted as `firstname-lastname.jpg`
4 changes: 0 additions & 4 deletions docs/Branding.mdx → docs/pages/branding.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
import { Meta } from "@storybook/blocks";

<Meta title="3. Branding" />

# Branding

## Logo
Expand Down
19 changes: 19 additions & 0 deletions docs/pages/member-levels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Member Levels

This is how we categorize members so we can match them with the right opportunities.

## Student

- You are currently enrolled in a degree program or a coding bootcamp
- e.g., bootcamp student, a computer science student, self-taught

## Individual Contributor

- You are currently or were recently employed as a software engineer
- Or you are a recent graduate and are actively looking for a job
- e.g., fullstack engineer, developer advocate, data scientist

## Leader

- You are currently or were recently employed as a manager, director, or executive
- e.g., engineering manager, CTO, technical founder
12 changes: 12 additions & 0 deletions docs/pages/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Overview

## Vision

Amplify opportunities for over 1,000 Latina software engineers by 2025.

## Timeline

- the idea started in October 2022
- initial website launched January 2023
- first MVP launched June 2023
- targeting October 2023 for user auth + database
Binary file added public/img/favicons/favicon.ico
Binary file not shown.

0 comments on commit 43adcfd

Please sign in to comment.