layer5io / getnighthawk Goto Github PK

Current State of the GetNighthawk.dev site

Desired State of the GetNighthawk.dev site

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
The site currently has a placeholder logo. The official project logo can now be found here - layer5io/layer5#1780

Desired State of the GetNighthawk.dev site
The site should use this new logo.

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Currently, there are a few mistakes in the footer

Desired State of the GetNighthawk.dev site

• Move from “Socials” to “Social”
• Remove the community Section as most of the things listed under community are covered in other sections
• Fix any other relevant issue in the footer

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
A few buttons are not linked to any link

Desired State of the GetNighthawk.dev site
Requires linking of all the buttons to proper links

• Join Us - https://docs.google.com/document/d/18hYemFKK_PC_KbT_TDBUgb0rknOuIhikkRxer4_bv4Q/edit#
• Need link for Ask Us button
• Need link for Learn More button

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Description

Two different actions that need to be created:

Setup Environment action:
The action would do the following tasks:

• Setup dependencies for building the project such as bazel,gcc etc..
• Setup git credentials with tokens for cloning the repository.

Build and publish action:
The action would do the following tasks:

• Clones the specified nighthawk version
• Builds the project for client, server and test_server.
• Create a release in this repository for the corresponding version.
• Publish the build artifacts to this release.
• The artifact should follow the naming convention mentioned here - https://docs.google.com/document/d/1lHfMo4iIx2WXFZIspfHyxTsPR1T63_2IV5NUkgxoo0w/edit#

Environment:

• OS: [e.g. Ubuntu]
• Browser: [e.g. Chrome, Safari]
• Version: [e.g. 22]
• Device: [e.g. laptop, iPhone 8]

[Optional] To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

[Optional] Additional Context

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
A brief description of what the problem is.

The background colors, alignment, and spacing doesn't match the design

eg.

Desired State of the GetNighthawk.dev site
A brief description of the change you are requesting.

Matching all the alignments, colors, and spacing with the design https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs?node-id=5884%3A12909

eg.

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Duplicate answers in the FAQ section

Desired State of the GetNighthawk.dev site
Unique questions and answers requires

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Description
The #buzz channel should be notified each time that someone stars a repo.

Details
The name of this repo recently changed. The slack.yaml workflow needs updated to reflect this name change. See https://github.com/layer5io/getnighthawk/actions/runs/538443695

Current State of the GetNighthawk.dev site
Currently, we have a lot of code snippets in the index.html that are not in match with the Figma design mockup

Desired State of the GetNighthawk.dev site
Requires a clean up of the index.html with a proper comparison with the design mockup

Figma link for reference: https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs?node-id=2650%3A4236

Future goals related to this issue:

• Removal of the unused images and assets
• Removal of the unused CSS and scss files

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Description
The GetNighthawk site is not being built by GH Pages due to missing plugins stanza in _config.yaml.

Expected Behavior
Site should be updated with each merge of a PR that has changes in /docs folder.

Just a small typo in the steps to build GetNightHawk site.Step 3 is merged with Step 2.

• See the CONTRIBUTING.md
  

Current State of the GetNighthawk.dev site
Empty about page

Desired State of the GetNighthawk.dev site
Requires a single page layout/design for the about section.
@austinogiza

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
The line spacing differs from the website mockup:-

Desired State of the GetNighthawk.dev site
The line spacing needs to be like this:-

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
There is a "Why Getnighthawk section already present on the current website

Desired State of the GetNighthawk.dev site
screenshot from Figma:

This will require the development of the card component with a transition effect.

Contributor Resources

• See the Contributing to Meshery.io Website section of the readme.md.
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Hero section currently looks like this:-

Desired State of the GetNighthawk.dev site
Hero section needs to look like this:-

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Description
Currently, golangci-lint is failing due to some code issues like comments, whitespaces, new-line etc.

Errors to be fixed

  Running [/home/runner/golangci-lint-1.29.0-linux-amd64/golangci-lint run --out-format=github-actions] in [] ...

  ##[error]commentedOutCode: may want to remove commented-out code (gocritic)
  ##[error]commentedOutCode: may want to remove commented-out code (gocritic)
  ##[error]commentedOutCode: may want to remove commented-out code (gocritic)
  ##[error]line is 144 characters (lll)
  ##[error]unnecessary conversion (unconvert)
  ##[error]unnecessary trailing newline (whitespace)

  ##[error]issues found

  Ran golangci-lint in 1031ms

Expected Behaviour
Fix the linting issues and make the golangci-lint pass.

Current State of the GetNighthawk.dev site
Currently, there are 2 burger menus when we switch to the mobile view on the Docs page.

Desired State of the GetNighthawk.dev site
As discussed in the March 29th 2021 website meeting: Addition of a floating menu for the Docs section. In a similar way as it is on https://reactjs.org/docs/getting-started.html Any other suitable way of doing this can also be approached.

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current Behavior

There is no FAQ section on the current website

Desired Behavior

screenshot from Figma:

This section is supposed to be above the bottom newsletter signup component. Kindly refer to the figma design for better understanding of placement.

Resources

Alternatives / Additional Context

Current Behavior

Currently, the footer lacks alignment and proper placement of contents

Desired Behavior

Screenshot from Figma:

Resources

Alternatives / Additional Context

Current Situation

Each of the layer5 repositories needs releaseDrafter automation as had been done in the meshery project which takes care of drafting release notes.

Desired Situation

Add ReleaseDrafter configuration yaml file & GitHub Action.

Additional context

ReleaseDrafter Configuration File
ReleaseDrafter GitHub Action

Contributor Resources

• See layer5 contributing instructions

Current State of the GetNighthawk.dev site
Currently, we have only one section in the Docs, which is Documentation

Desired State of the GetNighthawk.dev site
We can have different folders for the different sub-sections and then display them accordingly on the Docs page.
A possible way for doing this can be by using an accordion or something similar to it. The logic here would be to iterate over the different docs.md files and provide all the data to the different sections accordingly.

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Currently, the favicon on getnighthawk.dev is that of Meshery's logo.

Desired State of the GetNighthawk.dev site
The GetNighthawk logo should be used instead. Find the GetNighthawk logo here - https://layer5.io/brand

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current Behavior

Currently, the navbar is based on the meshery.io theme.

Desired Behavior

needs to be implemented according to the following figma mockup
Use a placeholder logo until the final getnighthawk logo is prepared.

Resources

Refer to the 9th page of this doc to get more info about color scheme and Typography

Currently, the 'Why GetNighthawk' section on the homepage is not according to the Figma design.

The section should be modified according to the Figma design given - https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs?node-id=2650%3A4236

Environment:

• OS: [e.g. Ubuntu]
• Browser: [e.g. Chrome, Safari]
• Version: [e.g. 22]
• Device: [e.g. laptop, iPhone 8]

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State:
The CONTRIBUTING.md in this repo needs is missing some information and instructions specific to this project.

Desired State:
The CONTRIBUTING.md in this repo needs to be updated information about what framework and plugins that the GetNighthawk website uses. It also needs updated with instructions for how to contribute and how to build the GetNighthawk website.

Resource: See the GetNightHawk project doc for details

Description

Environment:

• Browser: Safari

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current Behavior
GetNighthawk site has two html pages.

Desired Behavior
A full Jekyll-based theme is needed. Using meshery.io's theme as a starting point makes much sense.

Current Behavior
This repo contains a website. This repo should have an issue template for Site Updates in here https://github.com/layer5io/getnighthawk/tree/master/.github/ISSUE_TEMPLATE.

Desired Behavior
Copy the site_update.md GitHub issue template from the layer5io/meshery.io repo to make a new issue template in the getnighthawk repo.

Current Behavior
Project mailing lists exist, but are not shown on the site.

Desired Behavior

These lists should be available for anyone to join:

• Users
• [Developers(https://groups.google.com/a/getnighthawk.dev/g/developers)
• Maintainers

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Currently, the hero section of the website as well as the "what is getnighthawk?" section has a grey background color.
check it out at - https://getnighthawk.dev/

Desired State of the GetNighthawk.dev site
The Figma design is a bit different for the hero section as it has a blue tone background color #C9FCF6. The "what is getnighthawk?" section is supposed to have a white background like all the other sections, instead of grey.

Figma design link - https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs?node-id=5884%3A12909

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Currently, there is no proper section for a complete nighthawk description

Desired State of the GetNighthawk.dev site
screenshot from figma for this section:

Contributor Resources

• See the Contributing to Meshery.io Website section of the readme.md.
• See the Project Site section of GetNighthawk project doc

Description
The Community section in the README says "Access the Community Drive". There is a new procedure of having this automated based on the individual filling in a community member form

Expected Behavior
Update "Access Community Drive" to "To Access Community Drive, fill Community Member Form"

Screenshots

Environment:

• OS: [e.g. Ubuntu]
• Browser: [e.g. Chrome, Safari]
• Version: [e.g. 22]
• Device: [e.g. laptop, iPhone 8]

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Description

There is a shell script which is a Debian/Ubuntu and derivatives spesific code there. I learn how our project is builded day by day but what about removing just sudo
Expected Behavior

sudo seems for me a security risk
Source for the reason of this issue

#!/bin/bash -ex

#####################################
#
# Build nighthawk binary
#
#####################################

sudo wget -O /usr/local/bin/bazel https://github.com/bazelbuild/bazelisk/releases/latest/download/bazelisk-linux-amd64
sudo chmod +x /usr/local/bin/bazel

sudo apt-get install \
   libtool \
   cmake \
   automake \
   autoconf \
   make \
   ninja-build \
   curl \
   unzip \
   virtualenv

The GetNighthawk Project will benefit from use of GitHub teams, so that those teams may be used for assigning reviewers.

1. getnighthawk-contributors - collection of all GetNighthawk contributors
2. getnighthawk-ci-contributors - collection of backend and CI-focused contributors
3. getnighthawk-site-contributors - collection of frontend-focused contributors
4. getnighthawk-maintainers - collection of project maintainers

Hierarchy of teams (and permissions):

1. site contributor structure

• getnighthawk-contributors - triage
  • getnighthawk-site-contributors - triage
    • getnighthawk-maintainers - write

2. ci contributor structure

• getnighthawk-contributors - triage
  • getnighthawk-ci-contributors - triage
    • getnighthawk-maintainers - write

Description

Welcome celebration image is not present for welcome bot
Expected Behavior

Add celebration image as is added in other layer5 repositories.

Current Behavior

The start section/hero section of getnighthawk is occupied by the previous following section:

Desired Behavior

needs to be implemented according to the following figma mockup
Use a placeholder logo until the final getnighthawk logo is prepared.

Resources

Refer to the 9th page of this doc to get more info about color scheme and Typography

Those participating in GetNighthawk will benefit from a mailing list as a form of asynchronous communication.

Current Behavior
The GetNighthawk is in need of a project logo.

Desired Behavior

1. A few logos are drafted, feedback is solicited and incorporated in to an iteration on the design.
2. A vote for favorite design is called for.
3. Winning has a logo package created and includes a number of color, vertical, horizontal, stacked, black, white, RGB, CMYK versions.

Current State of the GetNighthawk.dev site
Currently, the footer on the GetNighthawk project is a-bit unusual with uneven spacings and a lot of free space because of social icons being vertical.

Desired State of the GetNighthawk.dev site
It would be good if we bring down the social icons to the right of copyright text and address a few alignment issues.

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

The GH issue templates - https://github.com/layer5io/getnighthawk/tree/master/.github/ISSUE_TEMPLATE - need to be updated with details and links specific to the GetNighthawk project.

Current State of the GetNighthawk.dev site
Currently, we have a placeholder basic docs template

Desired State of the GetNighthawk.dev site
A menu layout for a simpler Docs section. Responsive Docs not required

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current Behavior
GetNighthawk does not build Nighthawk currently.

Desired Behavior
An initial successful build of Nighthawk using Envoy's toolchain is needed. Experiences from such a local build will inform how builds can be done in GitHub Actions.

Resources

• Envoy and Nighthawk's READMEs
• Envoy and Nighthawks GitHub Action workflows

Current Behavior

Currently, Nighthawk builds are being published to this repository for Nighthawk version v0.2. This is being done manually but invoking a GitHub Action trigger, more details about this can be found here - https://docs.google.com/document/d/1lHfMo4iIx2WXFZIspfHyxTsPR1T63_2IV5NUkgxoo0w/edit#heading=h.9c7u4vmlywzu

Desired Behavior

Given that we have the pipeline working for building and publishing binary as well as docker artefacts, we would want to have this automated with the Nighthawk repository. There are a several proposed ways to do this, we would want your attention on the same.

*** Proposal:
Trigger the Gihub Action in this repository from the nighthawk repository

It will be helpful to have insights in this regard @mum4k @oschaaf @leecalcote

Resources

https://docs.google.com/document/d/1lHfMo4iIx2WXFZIspfHyxTsPR1T63_2IV5NUkgxoo0w/edit#heading=h.9c7u4vmlywzu

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Newsletter signup is not present on the current website

Desired State of the GetNighthawk.dev site
Screenshot from Figma:

This section is supposed to be right above the footer

Contributor Resources

• See the Contributing to Meshery.io Website section of the readme.md.
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
Currently, there are two different independent sections for Stewarded by and Organized by.

Desired State of the GetNighthawk.dev site
The Figma design has both of these sections combined into one single section.

Figma design link - https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs?node-id=5046%3A0

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc

Current State of the GetNighthawk.dev site
The GetNighthawk logo has been revised. The logo on the site needs updated.

Desired State of the GetNighthawk.dev site
New logo is here - https://layer5.io/brand/getnighthawk-brand-kit.zip

Contributor Resources

• See the Contributing to getnighthawk.dev Website
• See the Project Site section of GetNighthawk project doc