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

Shut down website #743

Merged
merged 10 commits into from
Oct 2, 2024
Merged

Shut down website #743

merged 10 commits into from
Oct 2, 2024

Conversation

rmainwork
Copy link
Contributor

@rmainwork rmainwork commented Sep 18, 2024

This PR gets the repo ready to shut down the website (serf.io). However, I do have a few clarifying questions I'd like to call out.

  1. There is one here that I'm a little unclear about and hasn't been updated - namely docs/internals/simulator.html.erb.
    • Should this be converted to .html.markdown as well? It does look like an empty template that something is supposed to fill in, presumably with graphics of so
    • Is it considered "website code" (as-per 1e5befc and should be removed)
    • Should something else be done with it?
  2. I also moved the intro directory under /docs/intro (updating paths as needed) since some of the documentation under /docs linked to it, and it seemed like it might contain important context for people digging in to the project for the first time. Is this okay, or should I remove it?

As-per [this asana
ticket](https://app.asana.com/0/1207142155269470/1207142155269475/f)
move the contents of `website/source/docs` to `/docs`
We may wish to keep this information (it is markdown after all!) and
some of the docs reference it
As-per [this
ticket](https://app.asana.com/0/1207142155269470/1207142155269473/f). The
current content of these files are (were?) served up by the ruby application in
`/website` and could be accessed using `/docs/filename.html`. Since this is
being retired, this content now needs to be accessible (and navigable) from the
GitHub repository alone.

In order to accomplish this, links to `file.html` need to be rewritten
to `file.html.markdown`. The suggestion in the ticket was to use a
codemod to do this - however this could instead be accomplished using
the following `sed` expression:

```bash
find . -type f -name '*.*' -exec sed -i -E '
  s|\/intro\/(.*)\.html\)|\/docs\/intro\/\1.html.markdown\)|g;
  s|\/docs\/(.*)\.html\)|\/docs\/\1.html.markdown\)|g' {} +; git status
```
As-per [this ticket](https://app.asana.com/0/1207142155269470/1207142155269482/f) the wbesite
(and it's associated code) is being retired.
@rmainwork rmainwork marked this pull request as ready for review September 18, 2024 19:09
@rmainwork rmainwork requested a review from a team as a code owner September 18, 2024 19:09
@rmainwork rmainwork requested review from skpratt and removed request for a team September 18, 2024 19:09
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
demo/vagrant-cluster/README.md Outdated Show resolved Hide resolved
rmainwork and others added 3 commits September 19, 2024 16:26
We should be linking to the relative URL, not the blob URL. Also, the file extension should be `.markdown`, not `.html`

Co-authored-by: Byron Wolfman <[email protected]>
The correct link needs to have `/tree/master` in the URL, not just `github.com/serf/docs`.

Co-authored-by: Byron Wolfman <[email protected]>
@skpratt skpratt removed their request for review September 20, 2024 18:34
@rmainwork
Copy link
Contributor Author

rmainwork commented Sep 23, 2024

@skpratt - would you mind taking a 👀 . I think @byronwolfman's review was just to clean up the go linter errors for the most part. If you unassigned yourself because GH picked the wrong person, let me know and I can find someone else to take a look - cheers! 😄

@rboyer rboyer requested review from zalimeni and dhiaayachi and removed request for skpratt September 24, 2024 15:30
@rboyer
Copy link
Member

rboyer commented Sep 25, 2024

Will the parked domain have content specific permanent redirects left so permalinks go somewhere equivalent?

The consul and nomad websites deep link to the serf.io website:

consul $ git grep "serf.io"
content/docs/architecture/coordinates.mdx:All of this is provided through the use of the [Serf library](https://www.serf.io/).
content/docs/architecture/coordinates.mdx:[Serf's network coordinates here](https://www.serf.io/docs/internals/coordinates.html).
content/docs/architecture/gossip.mdx:through the [Serf library](https://www.serf.io/). The gossip protocol
content/docs/architecture/gossip.mdx:Refer to the [Serf documentation](https://www.serf.io/docs/internals/gossip.html) for additional information about the gossip protocol.
content/docs/architecture/gossip.mdx:are able to perform their functions by leveraging an embedded [Serf](https://www.serf.io/)
content/docs/architecture/gossip.mdx:[Serf gossip protocol guide](https://www.serf.io/docs/internals/gossip.html#lifeguard)
content/docs/install/glossary.mdx:Consul is built on top of [Serf](https://www.serf.io/) which provides a full
content/docs/security/encryption/index.mdx:The gossip protocol, as well as its membership management and message broadcasting features, use the [Serf library](https://www.serf.io/). 
content/docs/troubleshoot/faq.mdx:Consul uses the [Serf](https://www.serf.io) gossip protocol which relies on

nomad $ git grep "serf.io"
nomad/server.go:	// This value was tuned using https://www.serf.io/docs/internals/simulator.html to
website/content/docs/concepts/gossip.mdx:to manage membership. This is provided through the use of the [Serf library](https://www.serf.io/).
website/content/docs/concepts/gossip.mdx:with a few minor adaptations. There are more details about [Serf's protocol here](https://www.serf.io/docs/concepts/gossip.html).
website/content/docs/concepts/gossip.mdx:All of these features are provided by leveraging [Serf](https://www.serf.io/). It
website/content/docs/concepts/security.mdx:| **4648** / TCP + UDP | Servers | [gossip](/nomad/docs/concepts/gossip) protocol to manage server membership using [Serf](https://www.serf.io/).                                                                           |

Specifically:

@rmainwork
Copy link
Contributor Author

rmainwork commented Sep 25, 2024

@rboyer I believe the parked domain will simply re-direct serf.io to the /docs directory in the GH repo. I could be wrong but I believe any deep links would need to be updated in the relevant places(in this case, the consul and nomad docs)....

@tkalus
Copy link

tkalus commented Sep 30, 2024

@rboyer I believe the parked domain will simply re-direct serf.io to the /docs directory in the GH repo. I could be wrong but I believe any deep links would need to be updated in the relevant places(in this case, the consul and nomad docs)....

Confirmed that hc-centralized-dns parked domain capabilities are a simple "entire domain" HTTP 302 redirect; we don't have the capability to handle complex/per-page redirects with that mechanism.

@rboyer
Copy link
Member

rboyer commented Oct 1, 2024

Are y'all going to take care of the followups in Consul and Nomad to avoid hitting the destination-removing 302 redirect for existing serf.io links?

@jmurret
Copy link
Member

jmurret commented Oct 1, 2024

Here is a PR for the consul side: hashicorp/consul#21797

@rmainwork
Copy link
Contributor Author

rmainwork commented Oct 2, 2024

@jmurret Just FYI - I took a quick look at that PR....I believe direct file links need to contain /blob and directory links need to contain /tree (as well as default branch name or a hyphen - i.e: blob/-/docs/faq.md). So, github.com/hashicorp/consul/docs/faq.md goes to a 404, instead the link would be github.com/hashicorp/consul/blob/-/docs/faq.md.

@jmurret
Copy link
Member

jmurret commented Oct 2, 2024

thank you @rmainwork . i was planning on test links once your PR was merged. this helpful to know.

@rmainwork rmainwork merged commit 62fdabe into master Oct 2, 2024
13 checks passed
@rmainwork rmainwork deleted the rm/serf-io-shutdown branch October 2, 2024 16:28
tgross added a commit to hashicorp/nomad that referenced this pull request Oct 2, 2024
The serf.io site is being taken down, so change all our links to point to the
repo docs instead.

Ref: hashicorp/serf#743
@tgross
Copy link
Member

tgross commented Oct 2, 2024

Nomad site PR here: hashicorp/nomad#24114

tgross added a commit to hashicorp/nomad that referenced this pull request Oct 2, 2024
The serf.io site is being taken down, so change all our links to point to the
repo docs instead.

Ref: hashicorp/serf#743
tgross added a commit to hashicorp/nomad that referenced this pull request Oct 2, 2024
The serf.io site is being taken down, so change all our links to point to the
repo docs instead.

Ref: hashicorp/serf#743
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.

6 participants