Skip to content

Remove duplicate sponsor images from documentation#1944

Closed
Zero3141 wants to merge 2 commits intosecureCodeBox:mainfrom
Zero3141:documentation/remove-duplicate-sponsors
Closed

Remove duplicate sponsor images from documentation#1944
Zero3141 wants to merge 2 commits intosecureCodeBox:mainfrom
Zero3141:documentation/remove-duplicate-sponsors

Conversation

@Zero3141
Copy link
Copy Markdown
Contributor

Description

Part of #942

Checklist

  • Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests.
  • Make sure that all your commits are signed-off and that you are added to the Contributors file.
  • Make sure that all CI finish successfully.
  • Optional (but appreciated): Make sure that all commits are Verified.

Heiko Kiesel added 2 commits September 11, 2023 11:43
Signed-off-by: Heiko Kiesel <heiko.kiesel@iteratec.com>
…rus build

Signed-off-by: Heiko Kiesel <heiko.kiesel@iteratec.com>
@Zero3141 Zero3141 added the documentation Improvements or additions to documentation label Sep 11, 2023
@Zero3141 Zero3141 self-assigned this Sep 11, 2023
@netlify
Copy link
Copy Markdown

netlify bot commented Sep 11, 2023

Deploy Preview for docs-securecodebox ready!

Name Link
🔨 Latest commit 58d7346
🔍 Latest deploy log https://app.netlify.com/sites/docs-securecodebox/deploys/64fee21726fbfe0008bf5152
😎 Deploy Preview https://deploy-preview-1944--docs-securecodebox.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Copy Markdown
Member

@Weltraumschaf Weltraumschaf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove any unnecessary code to build things. So IMO the images should reside in the docusaurus folder, so we do not need to move them around. In the main README we can simply deep link to these files.

Also we should consider if we can simplify the scanner/hooks docs generation, to get rid ofthe untested build scripts.

const docsConfig = {
repository: "secureCodeBox/secureCodeBox", // The repository url without the github part of the link
targetPath: "docs", // This needs to be 'docs' for the docusaurus build, but you may specify a 'docs/<subdirectory>'
targetPath: ".", // This needs to be '.' as files copied to docs (scanners & hooks) and static (sponsors) folder
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Id do not really understand the comment here.

dst: "docs/hooks",
},
{
src: "resources/sponsors",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why that? We can simply reference the images IMO in the main README directly, right?

@Zero3141
Copy link
Copy Markdown
Contributor Author

Replaced by #1950

@Zero3141 Zero3141 closed this Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants