Skip to content

reachable by url but not listed - #1850

Merged
jth-nw merged 1 commit into
devfrom
feat/1secure-beta-docs
Nov 9, 2026
Merged

jth-nw merged 1 commit into
devfrom
feat/1secure-beta-docs

Conversation

@jth-nw

@jth-nw jth-nw commented Nov 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds a 1securebeta product for the 1Secure Beta docs. It is reachable by URL but not listed anywhere on the site.

  • Hidden from the navbar and landing page (existing hideFromNavbar flag).
  • New generic noIndex product flag keeps it out of search engines and site search:
    • pages carry noindex, nofollow and are left out of the sitemap (the docs plugin's per-version noIndex option)
    • production robots.txt disallows the product's routes
    • the product is left out of the search product filter (SearchBar, SearchPage)
  • Placeholder page at docs/1securebeta/index.md, sidebar, and CODEOWNERS entries for the 1Secure docs team.

The content is public in this repo, like all docs. "Unlisted" means not linked or indexed, not access-controlled. The 1Secure team accepted that tradeoff.

Test plan

  • APP_EXTERNAL_URL=https://docs.netwrix.com DOCS_PRODUCT=1securebeta npm run build succeeds: robots.txt has Disallow: /docs/1securebeta, beta pages have noindex, nofollow, the sitemap has no beta URLs
  • generateNavbarDropdowns() and generateProductCategories() don't include the beta
  • node --test src/plugins/robotsTxt.test.mjs passes, with a new case for noIndex routes
  • Full-site build passes (CI on this PR)
  • Confirm the Algolia crawler respects the noindex tag and robots.txt for /docs/1securebeta

🤖 Generated with Claude Code

Adds a 1securebeta product that is reachable by URL but not listed:
hidden from the navbar and landing page (hideFromNavbar), and a new
noIndex flag keeps it out of search engines and site search. noIndex
sets the docs plugin's per-version noindex (robots meta tag, no sitemap
entry), disallows the product's routes in production robots.txt, and
removes the product from the search product filter.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Documentation PR Review

Editorial Review

docs/1securebeta/index.md

  • Completeness — Line 9: Nothing on the page tells readers that beta content can change before release, or where to find documentation for the released product. Someone who gets this URL may not know whether to rely on it. Suggested fix: add a sentence such as "Features and procedures described here can change before general availability. For the released product, see Netwrix 1Secure documentation." (Use the correct route for the 1Secure docs.)
  • Clarity — Line 9: "It isn't listed in the site navigation or search results" describes how the site is built, which doesn't help the reader. It also leaves a question open: may readers share the URL, or is the content confidential? Suggested fix: remove the sentence, or say what it means for the reader, for example "This page is available only by direct link. Don't share it outside the beta program." (Only if that is the intended policy.)
  • Clarity — Line 3: The description repeats the title and doesn't say what the reader can do or learn on the page, which the standard requires. Suggested fix: "Preview features and procedures for Netwrix 1Secure that are still in beta, before general availability."
  • Completeness — Line 11: The TODO comment doesn't render, so once this merges, the published page is one sentence long. That's fine for a placeholder, but add the beta overview (what's in the beta, who it's for, and how to give feedback) before you share the URL with beta users.

Summary

4 editorial suggestions across 1 file. Vale and Dale issues are auto-fixed separately.


What to do next:

Comment @claude on this PR followed by your instructions to get help:

  • @claude fix all issues — fix all editorial issues
  • @claude help improve the flow of this document — get writing assistance
  • @claude explain the voice issues — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

Automated fixes are only available for branches in this repository, not forks.

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Code Review

I found no blocking issues. I checked:

  • products.js: each version gets its own docs plugin with a single current version, so versions.current.noIndex covers single-version and multi-version products alike. kb: false keeps the product out of the KB copy step. The existing hideFromNavbar filters already drop it from the navbar and the landing page.
  • Routing and metadata: ProductMetaTags picks the longest matching path, so /docs/1secure and /docs/1securebeta don't collide. The beta also has no redirects or customRoutePath that could clash.
  • robotsTxt.js: importing products.js here is safe, since docusaurus.config.js already imports it in the same Node context. Using all of PRODUCTS rather than only the active products is correct, so single-product builds produce the same robots.txt. On non-production hosts the output is unchanged (still Disallow: /).
  • Search filter: SearchBar and SearchPage filter the same way, so the two dropdowns stay in sync.
  • CODEOWNERS entries are correct.

Non-blocking note: robots.txt Disallow and noindex work against each other for Google. When robots.txt blocks a URL, Googlebot never fetches the page, so it never sees the noindex meta tag. If someone links to a beta URL from outside the site, Google can still index the bare URL, without content, as "Indexed, though blocked by robots.txt." Google's guidance is to use noindex alone when the goal is to keep pages out of the index. If Google is the main concern, consider dropping the Disallow and relying on noindex plus the sitemap exclusion. If keeping crawlers off the pages entirely matters more, for example for Algolia or other bots, the current setup is a reasonable tradeoff. Either way, I'd make the choice on purpose.

Nit: Disallow: /docs/1securebeta is a prefix match, so it would also block any future route that starts with the same string, such as /docs/1securebeta2. That doesn't matter today.

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

Auto-Fix Summary

0 issues fixed, 0 skipped across 1 files

Ask @claude on this PR if you'd like an explanation of any fix.

@jth-nw jth-nw changed the title feat(1secure): add unlisted 1Secure Beta product reachable by url but not listed Nov 9, 2026
@jth-nw
jth-nw merged commit 2bfb99f into dev Nov 9, 2026
14 checks passed
@jth-nw
jth-nw deleted the feat/1secure-beta-docs branch November 9, 2026 23:01

This branch was previously deployed

1 inactive deployment
development — 613ed9c8 Deployed Nov 9, 2026 by jth-nw via build-and-deploy #5101
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

Successfully merging this pull request may close these issues.

1 participant