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

Feature durable links #147

Merged
merged 5 commits into from
Nov 30, 2023
Merged

Conversation

Mikerniker
Copy link
Contributor

Summary of Changes

Used yarn docusaurus docs:version 2.1.0 to add durable links and changed filepath for .png images in version-2.1.0/deployment/best-practices.md to fix image not found error.

Related Issue

Closes #67

Checklist

  • I have read and followed the project's contribution guidelines, including code style and commit message conventions.
  • My code is well-documented, and I've updated relevant documentation.
  • I have added or updated test cases to ensure the code's functionality.
  • I have tested these changes on my local environment.
  • All tests pass, and there are no new linting errors.
  • I have reviewed and proofread my code and the changes.
  • The branch is up-to-date with the base branch.

Screenshots (if applicable)

Additional Context

Reviewer(s)

Hi @hexsecs,

I tried tagging the new version with the yarn command. Let me know if I need to make changes. Thank you

Copy link

argos-ci bot commented Nov 21, 2023

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
default (Inspect) 🧿 Changes detected (Review) 35 changes Nov 30, 2023, 5:46 PM

Copy link
Collaborator

@Abhijay007 Abhijay007 left a comment

Choose a reason for hiding this comment

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

@Mikerniker we also need to update the docusaurus.config.js file as well

here is what we needs to be update :

   ({
        docs: {
          sidebarPath: require.resolve('./sidebars.js'),
          // Please change this to your repo.
          lastVersion: "current",
          versions: {
            current: {
              label: 'Latest',
            },
            "2.1.0": {
              label: "2.1.0",
            },
            "2.0.0": {
              label: "2.0.0",
            },
            "1.2.0": {
              label: "1.2.0",
            },
            "1.1.0": {
              label: "1.1.0",
            },
            "1.0.0": {
              label: "1.0.0",
            },
          },
        },

just remove the (2.1.0) from the latest and also add a new label for the version 2.1.0

@Mikerniker
Copy link
Contributor Author

ok, thanks @Abhijay007 , I have added the change to the docusaurus.config.js file

Abhijay007
Abhijay007 previously approved these changes Nov 27, 2023
Copy link
Collaborator

@Abhijay007 Abhijay007 left a comment

Choose a reason for hiding this comment

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

LGTM 👍

jhdalek55
jhdalek55 previously approved these changes Nov 27, 2023
Copy link
Collaborator

@jhdalek55 jhdalek55 left a comment

Choose a reason for hiding this comment

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

I'm not really qualified to check the code. The text was existing material. I approve, but others should check as well.

@hexsecs
Copy link
Member

hexsecs commented Nov 27, 2023

This LGTM, but I currently have a question on this ticket for docusaurus. facebook/docusaurus#9049

It might be the best option to have the latest version redirect to a hardlink.

Copy link
Member

@hexsecs hexsecs left a comment

Choose a reason for hiding this comment

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

I added some feedback. We still want a solution were we have a link to the latest version. I think the suggestions I made should resolve that.

docusaurus.config.js Outdated Show resolved Hide resolved
docusaurus.config.js Outdated Show resolved Hide resolved
docusaurus.config.js Show resolved Hide resolved
docusaurus.config.js Show resolved Hide resolved
@hexsecs hexsecs dismissed stale reviews from jhdalek55 and Abhijay007 via 6be00b5 November 30, 2023 17:37
Copy link
Member

@hexsecs hexsecs left a comment

Choose a reason for hiding this comment

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

Looks good now.

@hexsecs hexsecs merged commit d273776 into uptane:main Nov 30, 2023
2 checks passed
@Mikerniker
Copy link
Contributor Author

ok, thank you!

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.

Durable Links
4 participants