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

Docs: Change the Route of the Code Search to "/codes/search" to Align With the Piral CLI Output #604

Merged
merged 2 commits into from
May 31, 2023

Conversation

manuelroemer
Copy link
Member

New Pull Request

For more information, see the CONTRIBUTING guide.

Prerequisites

Please make sure you can check the following boxes:

  • I have read the CONTRIBUTING document
  • My code follows the code style of this project
  • All new and existing tests passed

Type(s) of Changes

Contribution Type

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue, please reference the issue id)
  • New feature (non-breaking change which adds functionality, make sure to open an associated issue first)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • I have updated the documentation accordingly
  • I have added tests to cover my changes

Description

The Piral CLI, when running into an error code, tells us that we should go to https://docs.piral.io/code/search. The issue is that, at the moment, this page doesn't exist:
grafik

I changed the routes/redirects in the documentation to match the output. I believe that the /code/search URL is the one we want to use (in contrast to the "old" /reference/codes/search)?

Locally, everything works fine now, see:
grafik

grafik

Remarks

Does this go in the documentation branch? If not, change that please. 😄

@manuelroemer manuelroemer added the documentation Concerns the available documentation. label May 31, 2023
@manuelroemer
Copy link
Member Author

Oh right, I think I branched off develop. I can remake these changes, starting from documentation if that is an issue...

CHANGELOG.md Outdated
@@ -1,5 +1,11 @@
# Piral Changelog

## 0.15.13 (tbd)
Copy link
Contributor

Choose a reason for hiding this comment

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

This PR seems to take develop as a basis and push to documentation. Can we take documentation as a basis?

src/pages/docs/docs.config.json Show resolved Hide resolved
src/pages/docs/docs.config.json Outdated Show resolved Hide resolved
@FlorianRappl
Copy link
Contributor

@manuelroemer

Oh right, I think I branched off develop. I can remake these changes, starting from documentation if that is an issue...

I think either put it back into develop (it will be merged into documentation on the next release, i.e., soon / today) or start with documentation as a branch.

@manuelroemer
Copy link
Member Author

I think either put it back into develop [...]

I'll take that option then.

@manuelroemer manuelroemer changed the base branch from documentation to develop May 31, 2023 08:55
@FlorianRappl FlorianRappl merged commit 784a195 into develop May 31, 2023
@FlorianRappl FlorianRappl added this to the 0.15.13 milestone May 31, 2023
@manuelroemer manuelroemer deleted the doc/code-search-urls-fix branch June 19, 2023 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Concerns the available documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants