Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stop linking to internal documents from public documents #1252

Open
mattias-p opened this issue Apr 5, 2024 · 1 comment
Open

Stop linking to internal documents from public documents #1252

mattias-p opened this issue Apr 5, 2024 · 1 comment

Comments

@mattias-p
Copy link
Member

Today we have some links under docs/public that refer to files in the docs/internal. For each one of these we need to make up our minds on whether the linked information is public or not. If yes, the document (or part of it) should be moved into docs/public. If not, we should stop linking to it from documents under docs/public.

This command lists all public documents that link to internal documents.

grep -l -R docs/internal docs/public
@matsduf
Copy link
Contributor

matsduf commented Apr 8, 2024

Your grep command returned nothing, but the following returns 8 links:

grep -R ../internal docs/public

I disagree on "stop linking to internal documents from public documents" if it is meant to mean never.

  1. "Internal documents" are really not internal. Maybe we should call it something else. Those are documents that people outside the work group rarely need.
  2. "Public" is not a good choice either. Maybe we should call it something else.
  3. The "internal" documents that are linked to from the Public document tree should be reviewed and maybe moved to the Public tree.
  4. The compilation of the Public document tree by mdbook has a limitation that relative links from document in the Public tree to a document inside this repository (zonemaster/zonemaster) but outside the Public tree do not work. A work-around is to use absolute link for those. That also applies to links documents in "test-zone-data"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants