diff --git a/_guide-pages/2FA.html b/_guide-pages/2FA.html new file mode 100644 index 0000000000..f8b859dc51 --- /dev/null +++ b/_guide-pages/2FA.html @@ -0,0 +1,227 @@ +--- +title: 2FA Guide +description:

Hack for LA requires two-factor authentication (2FA) in GitHub for all project contributors. +

+in-this-guide: + - name: To Enable 2FA + link: '#To-Enable-2FA' + - name: FAQ + link: '#FAQ' + +--- + +
+ + +
+
+

To Enable 2FA:

+
Visit and follow Github's Guide to Setting Up 2FA
+
+ +
+

If you already have a 2FA application on your mobile phone, you can use that. If you do not already have a 2FA application you will be instructed to download your mobile app of choice (we have had good luck with Authy) and follow the detailed instructions to complete configuration in GitHub.


+
+ +
+ +
+
+ + +
+ +
+

Frequently Asked Questions

+
+
+ + +

What is 2FA?

+ +
+

Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. With 2FA, you have to log in with your username and password, and then provide another form of authentication that only you know or have access to.

+ Read more information about 2FA at GitHub + +
+ +

Why set up 2FA now?

+
+
    +
  • We are in the process of establishing best practices on Hack for LA projects and in the HfLA organization’s GitHub account.
  • +
  • There have been recent news items about hackers attempting to hold open source repositories for ransom. Although these attempts have mostly been unsuccessful, it is still a good reminder that we should use security best practices.
  • +
+ +
+

Encountering challenges using Git CLI after setting up 2FA? (Developers)

+
+ +

You might encounter a challenge using the Git CLI after enabling 2-Factor Authentication if you have not used the ssh link for the repo URL.


+ +

If you clone via the ssh URL for a repo, e.g.

+

git@github.com:hackforla/governance.git

+

instead of the https URL, e.g.

+

https://github.com/hackforla/governance.git

+

then you probably won't run into any issues after enabling 2FA, as you already use an SSH key.


+ +

Read more about connecting to GitHub with SSH.

+

Also, these steps might help you get the CLI auth working again:

+
    +
  1. Try pushing code from the CLI, if you get rejected unexpectedly it’s 2FA (if you enabled it)

  2. +
  3. Clear your cached GH credentials

  4. +
  5. Create a token at GH.com, which you’ll use as your CLI password

  6. +

+

If you are still having issues using 2FA with your CLI, please reach out to the #ops channel on the Hack for LA Slack.

+
+
+
+ + +
+ + + \ No newline at end of file diff --git a/_guide-pages/github-issues.md b/_guide-pages/github-issues..html similarity index 100% rename from _guide-pages/github-issues.md rename to _guide-pages/github-issues..html diff --git a/_guide-pages/github-issues.html b/_guide-pages/github-issues.html new file mode 100644 index 0000000000..16ef426af0 --- /dev/null +++ b/_guide-pages/github-issues.html @@ -0,0 +1,257 @@ +--- +title: Getting the Most Out of GitHub Issues +description: Each of Hack for LA’s GitHub project repositories (repos) use issues to track and organize ideas, enhancements, and tasks. All team members will use GitHub issues to communicate in our multifunctional teams.

When creating a new GitHub issue, the following tips will help you provide consistent formatting, a clear and concise overview, actionable tasks, explanatory resources, and resumé items to add value for all volunteers.

All GitHub Issues use markdown for formatting. View GitHub’s Mastering Markdown for a simple guide. +in-this-guide: + - name: Example of a Good End-to-End Issue + link: '#example-issue' + - name: Issue Sections - Description and Tips + link: '#issue-sections' + - name: Issue Template + link: '#issue-template' + - name: Member Analytics + link: '#member-analytics' +--- + + + + + + + +
+

Issue Sections: Descriptions and Tips

+
Follow the recommendations below to create a useful end-to-end GitHub issue
+

You can either format with markdown text manually or using the text box toolbar


+ +

TITLE

+

+ Describe what you’re working on —

+ For a start-to-finish issue, as in this case, choose a title that is generic enough to allow for all phases (research, ideation, design, development).

+ For an issue taking on only part of the workflow, be more declarative in what it covers (e.g. a research issue might be called “Determine Best Testing Library for Code Base”). +


+
+
+



+ + +

OVERVIEW

+

Clearly state the purpose of this issue in 2 lines or less.

+
+ +

Markdown draft: ### formats header

+

+
+
+
+

Final post

+



+ + +

DEPENDENCY

+ (if applicable)
+

If your issue relies on another issue’s completion first, link to the issue it is dependent on.

+
+ +

Markdown draft: [title](url) formats links

+

+
+
+ +

Final post

+



+ + +

ACTION ITEMS

+

+ Formatted as a clickable checklist.

+ If this is the beginning of the task, this is most likely something to be researched and documented.

+ When the research is complete, what will happen next? Describe the steps in your checklist (broadly, if the research will change the details).

+ If the steps can be divided into tasks for more than one person, we recommend dividing it up into separate sections. +


+
+ +

Markdown draft: - [ ] formats checklist

+

+
+
+ +

Final post


+

+
+
+ +

Final post with checkmarks

+



+ + +

RESOURCES / INSTRUCTIONS

+

+ If there is a link with documentation that helps with this issue, provide the link(s) here. +


+
+ +

Markdown draft

+

+
+
+ +

Final post

+



+ + +

RESUME

+

+ Specify how tasks can be listed in all assignees’ resumés to provide value for project volunteers, divided by roles. +


+
+ +

Markdown draft

+

+
+
+ +

Final post

+



+ + +

ASSIGNEES

+

+ Select assignees to clarify who is working on specific issues and pull requests.

+ In the upper-right corner, click Assignees. To assign a user (including yourself), start typing their username and click their name when it appears.

+ Assign the issue to only one person at a time, by order of their tasks. +


+ +


+ + +

LABELS

+

+ Select all relevant labels. See GitHub’s About Labels guide for more details. +


+ +


+ + +

PROJECT BOARD

+

+ Make sure your issue is added to your team’s Project Board, and properly triaged. Click here to learn more.

+ If the issue has been created but is not ready to assign, it should be set in the ice box.

+ If the issue has been created and is ready but not yet assigned to someone, it should be set in prioritized backlog.

+ When someone has been assigned to the issue, this should be set to in progress. +


+


+ + +

MILESTONES

+

+ You can use milestones to track the progress of groups of issues or pull requests in a repository. Read more at GitHub’s About Milestones guide. +


+


+ +

TIP:

PREVIEW

+

+ Don’t forget to preview your new issue before posting to make sure it’s formatted correctly. +


+


+
+ + +
+

Issue Template

+

Copy/paste the following markdown template text into your new GitHub issue and fill out using the guidelines above.


+ +
+ + +
+ + ### Overview
+
+ ### Action Items
+ - [ ]
+ - [ ]
+ - [ ]
+
+ ### Resources/Instructions
+ [link title](link URL)
+
+ ### Resume
+
+ UX Writing:
+ -
+ -
+ UI Mockup:
+ -
+ -
+ Developers:
+ -
+ -
+
+
+
+
+ + + + + + diff --git a/_sass/_main.scss b/_sass/_main.scss index daaa6fa691..dc703c0975 100644 --- a/_sass/_main.scss +++ b/_sass/_main.scss @@ -45,6 +45,7 @@ @import 'components/getting-started-page.scss'; @import 'components/project-meetings.scss'; @import 'components/guide-pages.scss'; +@import 'components/guide-pages/2FA.scss'; //Guide Pages (Within Components) @import 'components/guide-pages/github-issue-guide.scss'; diff --git a/_sass/components/_footer.scss b/_sass/components/_footer.scss index d651d3bf5c..0b3286aff8 100644 --- a/_sass/components/_footer.scss +++ b/_sass/components/_footer.scss @@ -34,6 +34,7 @@ } .social-header { - position: relative + position: relative; + color: #fa114f; } } diff --git a/_sass/components/guide-pages/2FA.scss b/_sass/components/guide-pages/2FA.scss new file mode 100644 index 0000000000..8880bfdfb0 --- /dev/null +++ b/_sass/components/guide-pages/2FA.scss @@ -0,0 +1,102 @@ +.accordion { + padding: 0.2rem; + +} + +#myCanvas { + justify-content: center; + text-align: center; + // width: 100%; + // height: 100%; + margin: auto; +} + +.donut-list li { + list-style: none; + margin: auto; + text-align: center; + padding: 1rem; +} + +.dot { + height: 2rem; + width: 2rem; + padding-right: 1rem; + margin-right: 1rem; + margin-top: 1rem; + border-radius: 50%; + display: inline-block; +} + +.used { + background-color: #89cff0; +} + +.never-used { + background-color: #0000ff; +} + +.indent { + padding-left: 2rem; +} + +.highlight { + background-color: #EDEDED; + word-wrap: break-word; +} + +.screenshot { + text-align: center; +} + +.screenshot-2FA img { + display: block; + margin-left: auto; + margin-right: auto; + min-width: 200px; +} + +.title-left { + text-align: left; +} + +@media #{$bp-tablet-up} { + .accordion { + min-width: 400px; + } + .screenshot-2FA img { + width: 100%; + } +} + +@media #{$bp-below-tablet} { + .screenshot-2FA img { + width: 100%; + } + + #myCanvas { + width: 80%; + } + + .donut-list li { + padding-left: 0.1rem; + text-align: left; + } +} + +@media #{$bp-below-desktop} { + .accordion { + min-width: 150px; + } + + .screenshot-2FA img { + min-width: 200px; + width: 100%; + } +} + +@media #{$bp-desktop-up} { + .screenshot-2FA img { + width: 50%; + } +} \ No newline at end of file diff --git a/assets/images/guides/2FA/2FA-Screenshot.png b/assets/images/guides/2FA/2FA-Screenshot.png new file mode 100644 index 0000000000..7821270597 Binary files /dev/null and b/assets/images/guides/2FA/2FA-Screenshot.png differ