deepfence / documentationwebsite Goto Github PK

Optional interactive feature

For the public website, we plan to support:

community.deepfence.io for the home page
docs.deepfence.io for the individual documentation pages

Hello BigPicture team,

We are an existing BigPicture client (Deepfence.io). I'm creating a documentation site using a single-page web app framework called Docusaurus (docusaurus.io). Do you have any advice on how to install the tracking javascript on this platform? Thank you

Hey Owen,

We just checked out Docusaurus as we weren't familiar with it. In looking through the docs, it doesn't seem there's an easy, straight forward way to install misc scripts.

Apart from creating a custom BigPicture plugin, the "easiest" way may be via Google Tag Manager (GTM). It appears there's already a plugin for that (https://www.npmjs.com/package/docusaurus-gtm-plugin). So you could install that, then load BP via GTM. That should work, but it may require some tweaking / testing to ensure it only fires in your prod environment.

In dark mode, the GH icon on the home page is black. Should be white (or light gray)

Giving shoutouts in the right home page actually boosts the number of people who will eventually contribute to the repo.

If the reviewer find the issue logical and has worth in it. Do assign me to this I would like to contribute.

Notes:

• curl -s https://hub.docker.com/v2/repositories/deepfenceio/deepfence_agent_ce | jq '.pull_count'

See discussion in #20

Summary:

Home page render makes 6 unauthenticated calls to GH API. GH limits each source IP to 60 calls per hour, meaning the home page will not display GH stats for a user if they visit the home page 7 times in one hour.

An authentication token could overcome this, but has other issues. A better solution would be to (either or both):

• reduce the number of calls from 6 to 1, by refactoring the GH buttons to share the API call
• cache the GH api calls locally for 60 minutes

Provide community pack with icons, logos, terms of use, sample content and FAQs for potential writers.

See https://drive.google.com/drive/u/1/folders/1LWi4tl-RCuxSi6FyMBTFlT16wECk4HI0

Deepfence Cloud Ts&Cs and SLAs point to locations on the (legacy) sphinx docs site. Need to check and update the links when we publish new docs site

https://docusaurus.io/docs/versioning

Optional interactive feature

Build the full website (make build)

Check the ThreatMapper Architecture page (http://localhost/docs/threatmapper/architecture/)

Sometimes, the sidebar does not render (you only see the main content). Check the sidebars/threatmapper.js file; this problem appears to be related to the link / id:

      link: {
        type: 'doc',
        id: 'threatmapper/architecture/index'
      },

If it fails, try threatmapper/architecture.

Need to debug this, as the problem is difficult to detect and is intermittent. It does not appear to affect any other docs pages

Importing FlowMeter as a submodule fails:

$ git submodule update --remote
fatal: Needed a single revision
Unable to find current origin/master revision in submodule path 'product-docs/FlowMeter'

References: https://docusaurus.io/docs/deployment

You can:

1. Run an interactive build of the website using yarn start
2. Build and serve the website using yarn run serve --build --port 8001 --host 0.0.0.0

There's a basic NGINX proxy front-end that does TLS termination and forwards to the yarn process (port 8001).

TODO: Need to determine the final build and publish process for the website.

Something like the following:

Slack - join, meet engineers, ask and learn
GitHub - install and explore the products, share feature ideas and controbite
Twitter - latest community news
LinkedIn - meet the deepfence team
G2 - share your experiences with Deepfence projects

TODO: add gartner peer insights and invite for $25 for honest review

Optional interactive feature

API documentation:

https://github.com/deepfence/deepfence_runtime_api
https://deepfence.github.io/deepfence_runtime_api/ (edited)

We use swagger to generate .rst file / .html file
https://github.com/deepfence/deepfence_docs/blob/0c448525c6cbd83067dd642ac1abf9eb8a843471/api.rst
https://github.com/deepfence/deepfence_runtime_api/blob/master/index.html

Currently, the new docs point to the github repo for the API docs: https://.../threatstryker/api-reference so there’s no rush to move the API docs into the new platform.

Notes:

• https://github.com/ogarrett/CommunityWebsite/pull/1/files
• https://github.com/ogarrett/CommunityWebsite/pull/2/files