coreruleset / coreruleset/website

Documenting issues with website and documentation repos

Open
#64 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
1
Forks
9
Avg merge
5d 15h
Merged PRs (30d)
2

Description

Right now there are some problems or annoyances that we cannot solve with the current setup of documentation and website in different repos.

Let me add this list here for reference, maybe in the future we can solve this:

  • cross linking between them must use external urls, otherwise references won't be found.
  • we cannot mount documentation "inside" the website (using hugo mounts), because it will use only one theme, and we have a separated theme for the docs.
  • we cannot use aliases in the documentation (e.g. /installation was used a lot in blog posts) to use both urls properly.
  • updating the documentation triggers a deployment of the website, but the changes from the documentation will not be picked up due to the submodule reference. A separate PR to the website is currently necessary (should be fixed by #115)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names the separate website and documentation repositories but no files or tests. Start by reviewing the Hugo mounts and aliases references, the cross-linking concerns, and issue #115. Done would require an agreed resolution for the listed cross-repository problems.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo
Domain
documentation, web-dev
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.