Skip to content

Update docs.yaml#555

Merged
emeliawilkinson24 merged 8 commits intoapache:masterfrom
emeliawilkinson24:patch-1
Sep 25, 2023
Merged

Update docs.yaml#555
emeliawilkinson24 merged 8 commits intoapache:masterfrom
emeliawilkinson24:patch-1

Conversation

@emeliawilkinson24
Copy link
Copy Markdown
Contributor

Added/combined the following to the existing docs.yaml file:

checks:
external_links:
exclude:
- 'https://twitter.com/dsJavaDriver'
- 'https://twitter.com/datastaxeng' - 'https://twitter.com/datastax' - 'https://projectreactor.io' - 'https://docs.datastax.com/en/drivers/java/4.[0-9]+/com/datastax/oss/driver/internal/' - 'http://www.planetcassandra.org/blog/user-defined-functions-in-cassandra-3-0/' - 'http://www.planetcassandra.org/making-the-change-from-thrift-to-cql/' - 'https://academy.datastax.com/slack' - 'https://community.datastax.com/index.html' - 'https://micrometer.io/docs' - 'http://datastax.github.io/java-driver/features/shaded_jar/' internal_links: exclude: - 'netty_pipeline/' - '../core/' - '%5Bguava%20eviction%5D'

rewrites:

Added/combined the following to the existing docs.yaml file:

checks:
  external_links:
    exclude:
      - 'https://twitter.com/dsJavaDriver'
      - 'https://twitter.com/datastaxeng'
      - 'https://twitter.com/datastax'
      - 'https://projectreactor.io'
      - 'https://docs.datastax.com/en/drivers/java/4.[0-9]+/com/datastax/oss/driver/internal/'
      - 'http://www.planetcassandra.org/blog/user-defined-functions-in-cassandra-3-0/'
      - 'http://www.planetcassandra.org/making-the-change-from-thrift-to-cql/'
      - 'https://academy.datastax.com/slack'
      - 'https://community.datastax.com/index.html'
      - 'https://micrometer.io/docs'
      - 'http://datastax.github.io/java-driver/features/shaded_jar/'
  internal_links:
    exclude:
      - 'netty_pipeline/'
      - '../core/'
      - '%5Bguava%20eviction%5D'

rewrites:
  - search: 'https://(helpdocs|docs).datastax.com/(en/astra/)?(aws|gcp)/(dscloud/apollo|doc/dscloud/astra)/dscloudGettingStarted.html'
    replace: 'https://docs.datastax.com/en/astra-serverless/docs/getting-started/getting-started.html'
  - search: 'https://(helpdocs|docs).datastax.com/(en/astra/)?(aws|gcp)/(dscloud/apollo|doc/dscloud/astra)/dscloudObtainingCredentials.html'
    replace: 'https://docs.datastax.com/en/astra-serverless/docs/connect/secure-connect-bundle.html'
  - search: 'https://(helpdocs|docs).datastax.com/(en/astra/)?(aws|gcp)/(dscloud/apollo|doc/dscloud/astra)/dscloudShareClusterDetails.html'
    replace: 'https://docs.datastax.com/en/astra-serverless/docs/manage/org/manage-tokens.html'
  - search: 'http://downloads.datastax.com/java-driver/'
    replace: 'https://downloads.datastax.com/#datastax-drivers'
  - search: 'https://docs.datastax.com/en/drivers/java/(4.[0-9]+)/com/datastax/oss/driver/api/mapper/EntityHelper.html'
    replace: 'https://docs.datastax.com/en/drivers/java/\1/com/datastax/oss/driver/api/mapper/entity/EntityHelper.html'
  - search: '(http|https)://www.datastax.com/drivers/java/'
    replace: 'https://docs.datastax.com/en/drivers/java/'
  - search: 'http://docs.datastax.com/en/drivers/java'
    replace: 'https://docs.datastax.com/en/drivers/java'
  - search: 'https://docs.astra.datastax.com/docs/creating-your-astra-database'
    replace: 'https://docs.datastax.com/en/astra-serverless/docs/getting-started/create-db-choices.html'
  - search: 'https://docs.astra.datastax.com/docs/obtaining-database-credentials'
    replace: 'https://docs.datastax.com/en/astra-serverless/docs/connect/secure-connect-bundle.html'
  - search: 'https://docs.datastax.com/en/drivers/java/(4.[0-9]+)/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html%60'
    replace: 'https://docs.datastax.com/en/drivers/java/\1/com/datastax/oss/driver/api/core/cql/SyncCqlSession.html'
  - search: 'https://code.google.com/p/snappy/'
    replace: 'https://google.github.io/snappy/'
  - search: 'https://code.google.com/p/guava-libraries/wiki/ListenableFutureExplained'
    replace: 'https://github.com/google/guava/wiki/ListenableFutureExplained'
  - search: 'https://community.datastax.com/index.html'
    replace: 'https://www.datastax.com/workshops'
Comment thread docs.yaml Outdated
- http://docs.datastax.com/en/developer/cpp-driver/latest/: / # Get current version documentation
- https://github.com/datastax/cpp-driver/blob/master/vc_build.bat: https://github.com/datastax/cpp-driver/blob/2.14.0/vc_build.bat
- search: 'https://community.datastax.com/index.html'
replace: 'https://www.datastax.com/workshops'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Something doesn't seem right here; we also have this exact same URL (https://community.datastax.com/index.html) listed in the excludes above. Seems like we should use one or the other.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In related news: I got an email from @msmygit earlier today indicating that we should use https://cassandra.apache.org/_/community.html as the reference point instead of this. I'm not sure which we actually want to use in this case... maybe @msmygit can clarify?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Yes, we have already decommissioned https://community.datastax.com and are now sending folks over to StackOverflow and StackExchange as highlighted in the OSS Apache Cassandra community page that Bret has above.

Comment thread docs.yaml Outdated
- 'https://twitter.com/datastax'
- 'https://academy.datastax.com/slack'
- 'http://sourceforge.net/projects/boost/files/boost-binaries/1.[0-9]+.0/boost_1_[0-9]+_0-msvc-[0-9]+.[0-9]+-(64|32).exe/download'
- 'https://community.datastax.com/index.html'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is not longer in existence. Pls switch over to the other apache link pls.

replaced community link with https://cassandra.apache.org/_/community.html  in docs.yaml
removed exclude for community link because we added a rewrite for it to Madhavan's new link instead
Comment thread docs.yaml Outdated
- '^https?://travis-ci.org/*'
- '^https?://ci.appveyor.com/*'
- 'https://twitter.com/datastax'
- 'https://academy.datastax.com/slack'
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Apologies for not capturing this earlier, but Academy Slack is also not in operation anymore. We need https://dtsx.io/discord instead.

Copy link
Copy Markdown

@msmygit msmygit left a comment

Choose a reason for hiding this comment

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

👍🏼 LGTM -- ready to go!

Comment thread docs.yaml Outdated
- '^https?://travis-ci.org/*'
- '^https?://ci.appveyor.com/*'
- 'https://twitter.com/datastax'
- 'http://sourceforge.net/projects/boost/files/boost-binaries/1.[0-9]+.0/boost_1_[0-9]+_0-msvc-[0-9]+.[0-9]+-(64|32).exe/download'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd argue that instead of excluding this we should make anything matching this expression a redirect to https://www.boost.org/users/download/. Whatever is using this link in the C++ docs is historical (there's no reference to it in the current docs) but it's pretty clear from the URL itself that we're looking for the download server for the Boost libs... and the URL I mention above is where you go to get those libs nowadays.

@emeliawilkinson24 emeliawilkinson24 merged commit d56c47f into apache:master Sep 25, 2023
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.

3 participants