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

Extend CIP-0001 to cover internationalized content #542

Merged
merged 3 commits into from
Jul 7, 2023
Merged

Extend CIP-0001 to cover internationalized content #542

merged 3 commits into from
Jul 7, 2023

Conversation

KtorZ
Copy link
Member

@KtorZ KtorZ commented Jul 4, 2023

(new addition = Translations section)

@KtorZ KtorZ requested review from rphair, SebastienGllmt and Ryun1 July 4, 2023 13:50
@KtorZ KtorZ added Update Adds content or significantly reworks an existing proposal Category: Meta Proposals belonging to the 'Meta' category. labels Jul 4, 2023
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

nicely done; answers all of my questions last phrased in #539 (comment) except the one that came up in the last hour's CIP meeting; ready to approve otherwise.

CIP-0001/README.md Outdated Show resolved Hide resolved
Co-authored-by: Robert Phair <[email protected]>
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

@KtorZ as per #539 (comment) we're going to get people leaving the CIP field out unless it's specified explicitly.

If not considered important to the human reader, and even if not used (as I would think it would be) to accumulate translations along with the originals by site building scripts, this number is ultimately like a primary key in a table that, failing everything else, will line up the CIP with its translation (even if URLs go out of date for instance).

CIP-0001/README.md Show resolved Hide resolved
@Ryun1
Copy link
Collaborator

Ryun1 commented Jul 5, 2023

I do wonder if for the Revision field we include a URL with the commit hash? something like 18e692b <https://github.com/cardano-foundation/CIPs/pull/539/commits/18e692b5525bb7909c3637e793a449e0c01bd47b>? This would make navigation easier, no need to manually search for the commit hash.

@rphair
Copy link
Collaborator

rphair commented Jul 5, 2023

@Ryun1 how we considered this idea in the rapid-fire discussion at the meeting (and some in the GitHub threads w/@KtorZ afterward) was:

  1. The original proposal URL needs to be there in full so that naive users can click into it without having to follow or deduce it from the dressing on the GitHub page for the translated document... since this takes some familiarity with GitHub to know how to do.
  2. The commit hash does not require this convenience because anyone interested in a commit hash is a sophisticated user who will know where to find the History link on the web page for the canonical GitHub link in the translation header.

@Ryun1
Copy link
Collaborator

Ryun1 commented Jul 5, 2023

@rphair

I got lost in some of the rapid fire meeting discussions! 🤓

What you described does sound very reasonable to me and I am happy to approve.

For the sake of it, I guess the other downside of the current approach is that the only way the naive users can tell if their translation is behind the current CIP is by searching and following the commit trail. But this should not really be much of an issue, since merged CIPs do not change too much, thus translations are not too likely to be out of date quickly or frequenctly.

Co-authored-by: Robert Phair <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Meta Proposals belonging to the 'Meta' category. Update Adds content or significantly reworks an existing proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants