Repository navigation
Show the root logo in every README, link the main contributing guide, and fix the README links - #49
Merged
Merged
Conversation
… and fix the README links Six READMEs showed an older 51Degrees wordmark from 51degrees.com rather than the logo the root README shows. 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 root CONTRIBUTING.md linked the guide in common-ci. It now links the 51Degrees contributing guide, which leads on to the full guide in common-ci. The Developer Documentation link at the top of six READMEs went to the main page of the product's generated API reference, which has no content. They now go to the product's documentation. The root README's table links both that and the class list of the Java API reference, and the pipeline README's sentence about the API reference links the class list. The dependencies page that the Device Detection and IP Intelligence READMEs linked is gone, and the next sentence in each already links the tested versions page, so the sentence is removed. The location README's Maven link went to search.maven.org, which answers 403, and now goes to the artifact on central.sonatype.com.
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 that came in with the separate repositories still carry what those repositories had, as 51degrees-dotnet#75 found for .NET.
.github/images/logo.png, the 51D mark beside the Java logo. Six READMEs show an older 51Degrees wordmark from 51degrees.com instead.CONTRIBUTING.mdlinks the guide in common-ci rather than the 51Degrees contributing guide, which every repository without its own guide shows.Change
.github/images/logo-160.pngis a 160 pixel copy of.github/images/logo.png, the size the root README shows it at. The six READMEs show it as a Markdown image fromraw.githubusercontent.com, as the package READMEs in the other repositories do, where package sites need an absolute address.CONTRIBUTING.mdlinks the 51Degrees contributing guide, which leads on to the full guide in common-ci. It is the only contributing guide in the repository._device_detection__index.html, which only lists the pages in the section, goes to the same pages.The logo is linked from
main, so viewing these READMEs onrcshows it missing until rc is released into main.Not changed
The same change in the other languages
The same change is merged in 51degrees-dotnet#75, 51degrees-php#36, 51degrees-go#58, 51degrees-rust#277 and, today, 51degrees-python#46 and 51degrees-node#33. This draft follows them, showing the root logo at 160 pixels from
raw.githubusercontent.com, linking the one 51Degrees contributing guide and sending each documentation link to a page with content. Java is the last repository without it.Checks
Setting 'PullRequestSha' to '4ef050ef6d70dd6c18ccf5721388c1d933fb930f', ten lines over the ten jobs with no other value, and that is this branch's head. No job ended in anything but success or skipped.Release note
The READMEs show the 51Degrees logo the repository's README shows, and their documentation links go to pages with content.
The heading beside the logo in
location/README.mdstill says Pipeline API for the geo-location package. The text beside each logo is outside this change and is left as it was.