Repository navigation
Show the root logo in every README, add one contributing guide, and fix the README links - #33
Merged
Merged
Conversation
…ix the README links Twenty READMEs and example guides showed an older 51Degrees wordmark from 51degrees.com rather than the logo the root README shows, and the fiftyone.pipeline.did package README had none. Each now shows the root logo as a Markdown image from raw.githubusercontent.com, using .github/images/logo-160.png, a 160 pixel copy of .github/images/logo.png, the size the root README shows it at. The repository had no contributing guide of its own. One CONTRIBUTING.md at the root now links the 51Degrees contributing guide. The Developer Documentation link at the top of twenty READMEs and example guides went to the main page of the product's generated API reference, which has no content. They now go to the product's documentation, and the root README's table links both that and the class list of the Node.js API reference. The dependencies page that the Device Detection and IP Intelligence READMEs linked is gone. The IP Intelligence README's next sentence already links the tested versions page, so the sentence is removed, and the Device Detection README links the tested versions page in its place. The translation package's link to the on-premise package resolved nowhere, and now goes to it on GitHub, as npm cannot follow a relative link.
The documentation links went to section pages of the 51Degrees documentation, such as _device_detection__index.html, which only list the pages in the section. They now go to the page in each section that is most helpful to a developer and the most recently kept up to date. Those are the Device Detection, IP Intelligence and Reverse Geocoding quick starts, which show how to choose between the cloud and on-premise and how to start in each language, and Pipeline Basics for the Pipeline API, which has no quick start. The campaign tags of each link are unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The READMEs came in from the separate repositories and still carried what those
repositories had.
.github/images/logo.png. Every packageREADME showed the 51Degrees wordmark from
https://51degrees.com/img/logo.png,with campaign parameters on the image URL, and
fiftyone.pipeline.didshowed none.
51degrees-dotnet#75
found that nuget.org renders images only from
an allowed list of hosts
that 51degrees.com is not on, so the .NET package pages showed no logo at
all, and .NET, PHP, Go and Rust all moved to the repository's own mark
served from
raw.githubusercontent.com. How npmjs.com renders the old URLwas not checked for this change, because the reason to move is to show the
same mark as the other four languages wherever the README is read.
README, which a package page shows, went to the main page of that package's
generated API reference, for example
https://51degrees.com/ip-intelligence-node/index.html, which has nocontent. The root README's table linked the same kind of page for each of the
four products. Two READMEs linked a dependencies page that now redirects to
the documentation home page.
.NET, PHP, Go and Rust have all taken this change, so a reader of a Node
package README met a different mark and an empty documentation page where the
same package in another language showed the repository's mark and the quick
start.
Change
.github/images/logo-160.pngis a 160 pixel copy of.github/images/logo.png,the size the root README shows it at. Every package README, and the two
run_examples.mdfiles, now shows it as a Markdown image fromraw.githubusercontent.com, which is the host the other four languagesmoved to.
fiftyone.pipeline.did, which had no logo, gains it below its title. Theimage URL carries no campaign parameters, because it is not a 51degrees.com
link.
CONTRIBUTING.mdat the root links the51Degrees contributing guide
and says it applies to every package in this repository. The wording is the
same five lines .NET, PHP and Go use.
quick start or concepts page on 51degrees.com rather than to the empty
reference index, and the root README's table gives both the guide and the
Node.js API reference for each of the four products.
redirects to the documentation home. The tested versions link beside it
stays.
Every link keeps the five campaign parameters in the order
scripts/utm-lint.ps1enforces, withutm_source=npmandutm_medium=packagein a package README,
utm_source=githubandutm_medium=readmein the rootand folder READMEs and
utm_medium=docsin the tworun_examples.mdfiles,and
utm_termchanged where the destination changed.The same change in the other languages
The
CONTRIBUTING.mdhere is byte for byte the one51degrees-dotnet#75
added, and the logo URL has the same shape, pointing at
mainin thisrepository. Java #49 and
Python #46 carry it for
those two languages and are not mine.
Tests
Documentation only. No code changes, so there is no test to fail first and no
red run. This draft's own
utm-link-lint check
passes, which is the check that reads the campaign parameters on every link
this touches.
Full build. Run 43023120786,
on
tmp/pr-matrix-33, success. Every one of its sevenSetting 'PullRequestSha'lines reads6d0fa27df31abe4ac0b09c49babaec9bd4a06ffd, which is this head. Configureprinted "Left out 2 macOS entries". The branch it built from was
rcat8b9fc3d, and
rchas moved on since. Nothingrchas taken since touches aREADME, and the draft merges into the current
rcwith no conflict.macOS was left out of this draft's full build under the 9 November decision.
The rc head is built with macOS before it merges into main.
What remains
The logo URL points at
.github/images/logo-160.pngonmain, and this changeis what adds that file, so the image resolves once the change reaches
main..NET, PHP and Go all point at
mainin their own repositories in the same way.A reader on GitHub sees the image from this branch, and a reader of a published
package sees it from the first release after the merge.