Git Product home page Git Product logo

appsec's Introduction

Equinor AppSec public site

This repo contains the documentation and setup for hosting https://equinor.github.io/appsec/

Development

Install the dependencies using

pip install -r requirements.txt

To start the project, simply run:

mkdocs serve

and the server will start on localhost:8000.

.. or use e.g. Gitpod by click the Gitpod image/link above.

Adding content

To add content add markdown inside the docs folder, and link it from the rest of the site.

Runbook

A runbook of how the site is deployed and maintained can be found in Runbook.

How to contribute

Read our contribute.md

appsec's People

Contributors

aigelonic avatar ajaust avatar andreabrambilla avatar bra001 avatar dbelyaev avatar evtil avatar hholi avatar ipsitamishra16893 avatar larskaare avatar markusrf avatar mklarz avatar nimsilva avatar pettermk avatar reedonly avatar sean-sinclair avatar steinsiv avatar the-debarghya avatar thorvaldj avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

appsec's Issues

Naming conventions on guidelines

Over time more and more guidelines have been written.
It now is clear that there is no "naming convention" on the titles of the guidelines:
image

Make a convention such that:

  • The title only states what the guideline is about (avoid having the word "guideline" in the title itself)

Rendering on narrow screens

Rendering on phone or on "narrow" windows cuts away the menu on the left. And this makes it quite difficult to figure out what page to go next, (until you open the menu on the left side, but I tested it on the phone and it is annoying)

image

image

Maybe we should add "Next page" and "Previous page" links at the bottom of each page. Ideally this should be done automatically, but it depends on how much effort this will require

Dead link to Snyk guidelines

The link to the Snyk guidelines

- Consult the Equinor [Snyk Guidelines](https://equinor.github.io/appsec/snyk-guidelines/guidelines.html)

does not work for me. I get an 404 error when trying to access the page. It seems that mkdocs does not generate a page for the "Guidelines" group.

Review the entire website

A lot have changed in the past year, and the content of the page is not necessarily up-to-date and coherent. Someone should bother going through all the pages we have here, and if errors or inconsistencies are found, create dedicated issues (or fix them right away)

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.