Code Monkey home page Code Monkey logo

avd-generator's Introduction

Build Website

AVD Generator

Description

This is the page generator component of AVD

Generated Website

https://github.com/aquasecurity/avd

Building

Note: Set baseURL="/" here before proceeding.

tl;dr for just the UI

make hugo-devel and then navigate to http://localhost:1313 to view the site.

tl;dr for the full build with real content

make md-clean md-build sync-all md-generate hugo-generate nginx-restart then navigate to http://localhost:9011 to view the pages.

If changes are made to the existing AVD page structure (removal of existing fields), the following must be done:

  1. AVD content must be regenerated (rm -rf content/nvd && mkdir -p content/nvd)
  2. Build must be done manually and pushed up to AVD repo (not through GitHub Actions) This is needed to avoid tripping the Aqua Custom content logic.

To just build markdown pages:

make md-generate markdowns will be generated in avd-repo/content/

To just build the hugo site:

make hugo-generate site will be generated in avd-repo/docs/

To have a functional search:

  1. Run MeiliSearch locally docker run -p 7700:7700 -v $(pwd)/data.ms:/data.ms getmeili/meilisearch

  2. Setup search index curl -X POST 'http://127.0.0.1:7700/indexes' -H 'Content-Type: application/json' --data '{ "uid" : "avd", "primaryKey": "title"}'

  3. Add generated index.json to build search indexes curl -X POST 'http://127.0.0.1:7700/indexes/avd/documents' --data @docs/index.json

  4. To monitor index build progress: curl -X GET 'http://localhost:7700/indexes/avd/updates'

  5. Set the host and apiKey in static/js/fastsearch.js for using MeiliSearch:

meilisearch = new MeiliSearch({
         host: 'http://localhost',
         apiKey: "<public meilisearch if you set a master key only, otherwise remove>",
 })

avd-generator's People

Contributors

alphadev4 avatar dependabot[bot] avatar dmitriylewen avatar giorod3 avatar knqyf263 avatar liamg avatar lizrice avatar mehakseedat63 avatar morwn avatar nikpivkin avatar owenrumney avatar simar7 avatar tabakman avatar

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.