Rspec github repository is gone/private?

Rules and Languages
7

I ended up here after finding the downstream effects of making the RSPEC repository/site private.

The SonarSource/SonarJS repo still contains many public links to sonarsource.github.io/rspec, which now redirect users through GitHub authentication instead of showing the rule documentation:

I signed up for this Discourse to figure out what happened to these public docs.

I count 923 sonarsource.github.io/rspec occurrences across 626 committed files in SonarJS alone. GitHub code search also finds another 420 files referencing it outside SonarJS.

Eg. these links are now broken in PMD’s public rule documentation:

I understand from the update above that the full RSPEC repository/site isn’t coming back because of the IP protection.

G Ann Campbell, if you know anyone at SonarSource involved in this decision, could you ask them if such an option would be possible: Would it be possible to provide a public subset containing only the public docs intended for users?

Eg. one suggestion off the top of my head:

  1. Keep the public-facing rule documentation as Markdown files directly in repositories such as SonarJS, similar to the rule docs that were previously maintained in eslint-plugin-sonarjs, and link to those files from the generated rules table, meta.docs.url, IDE integrations, etc.

    This would avoid needing to maintain a separate documentation site, while allowing granular exposure of public docs without making the internal RSPEC content public again.