Skip to content

Stop trying to publish the unstable spec#1092

Merged
richvdh merged 1 commit into
masterfrom
rav/remove_unstable_spec
Oct 20, 2021
Merged

Stop trying to publish the unstable spec#1092
richvdh merged 1 commit into
masterfrom
rav/remove_unstable_spec

Conversation

@richvdh
Copy link
Copy Markdown
Member

@richvdh richvdh commented Oct 14, 2021

This hasn't really worked properly since matrix-doc was redesigned to use hugo, but we still had a few vestiges of the old code hanging around. In particular, there is no need to fetch the matrix-doc assets, and no need to attempt to style them.

I've also removed update_docs_local.sh since its purpose was unclear.

Preview: https://pr1092--matrix-org-previews.netlify.app

This hasn't really worked properly since matrix-doc was redesigned to use hugo,
but we still had a few vestiges of the old code hanging around. In particular,
there is no need to fetch the matrix-doc assets, and no need to attempt to
style them.
@richvdh richvdh requested a review from afranke October 14, 2021 14:54
Comment thread scripts/update_docs.sh
@afranke
Copy link
Copy Markdown
Contributor

afranke commented Oct 20, 2021

If build-spec is effectively going to do the same thing to the same committed files over and over again, considering any future version of the spec goes through a different process now, is there a point in keeping this at all? Couldn’t we just commit the styled files once and for all?

@afranke
Copy link
Copy Markdown
Contributor

afranke commented Oct 20, 2021

And just to confirm:

  • I am in favour of going in the direction of this PR, I just think it doesn’t go far enough.
  • the parts removed by @richvdh are already effectively useless, as the assets.tar.gz artifact only contains unstable.json nowadays, which we then copy over but don’t actually use anywhere (and https://matrix.org/docs/spec/client_server/unstable.json redirects to the new spec site)

@richvdh
Copy link
Copy Markdown
Member Author

richvdh commented Oct 20, 2021

If build-spec is effectively going to do the same thing to the same committed files over and over again, considering any future version of the spec goes through a different process now, is there a point in keeping this at all? Couldn’t we just commit the styled files once and for all?

I'm reluctant to do this, as it ties the spec to the same rendering forever more, even if the matrix.org homeserver gets a rebrand. And yes, in future, maybe we'll find alternative hosting for old versions of the spec, but we aren't there yet, so for now let's keep it as-is.

@richvdh
Copy link
Copy Markdown
Member Author

richvdh commented Oct 20, 2021

In view of the lack of objections, I'm going to take the executive decision to merge this.

@richvdh richvdh merged commit c2fd0cc into master Oct 20, 2021
@richvdh richvdh deleted the rav/remove_unstable_spec branch October 20, 2021 15:16
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