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

Update ipfs-updater.md #1125

Merged
merged 1 commit into from
Apr 28, 2022
Merged

Update ipfs-updater.md #1125

merged 1 commit into from
Apr 28, 2022

Conversation

mrodriguez3313
Copy link
Contributor

@mrodriguez3313 mrodriguez3313 commented Apr 27, 2022

Upgrading version numbers to latest ipfs-update tool version 1.8.0

https://discord.com/channels/806902334369824788/847893063841349652/968664117160341514

With regards to the automation of the docs version number. Maybe there can be a variable in a config file that holds the version number of the tool. With my experience with Jekyll sites, (idk what this one is) but there would be a variable that could look like this ipfs-update-tool : 1.8.0 and in each location where the version number goes (ex: line 20, etc...) we instead put {{ site.ipfs-update-tool }}. Now instead of manually changing each version number in this doc you just change the config file.

Upgrading version numbers to latest ipfs-update tool version 1.8.0
@welcome
Copy link

welcome bot commented Apr 27, 2022

Thank you for submitting this PR!
A maintainer will be here shortly to review it.
We are super grateful, but we are also overloaded! Help us by making sure that:

  • The context for this PR is clear, with relevant discussion, decisions and stakeholders linked/mentioned.
  • Your contribution itself is clear (grammar and spelling checked, any code blocks checked and commented) and in its best form. Follow the docs contribution guidelines if they apply.

Getting other community members to do a review would be great help too on complex PRs (you can ask in the chats/forums). If you are unsure about something, just leave us a comment.
Next steps:

  • A maintainer will triage and assign priority to this PR, commenting on any missing things and potentially assigning a reviewer for high priority items.
  • The PR gets reviews, discussed and approvals as needed.
  • The PR is merged by maintainers when it has been approved and comments addressed.

We currently aim to provide initial feedback/triaging within two business days. Please keep an eye on any labelling actions, as these will indicate priorities and status of your contribution.
We are very grateful for your contribution!

@johnnymatthews
Copy link
Contributor

With my experience with Jekyll sites

Nah, this is a VuePress site. But works in a similar way.

The only problem with having variables like that built into the markdown, is that it makes the markdown itself harder to read. It's also less portable. It'd be better to have a script with a list of files it needs to look at, and then scans those files periodically to check whether they're showing the latest ipfs-update version.

Anyway, thanks for this PR. It's in draft mode right now though, are you still working on it?

@mrodriguez3313
Copy link
Contributor Author

The reason I had it as a draft was to see if the conversation of automating it would develop. And if it would be something that I could help take care of? It could be its own seperate PR anyways and I could change this to done.

@mrodriguez3313 mrodriguez3313 marked this pull request as ready for review April 28, 2022 03:11
@johnnymatthews
Copy link
Contributor

Yeah it's best if we created a new issue and PR to address this automation problem.

There's an issue here for discussion: #1128

@johnnymatthews johnnymatthews merged commit 3d98bea into ipfs:main Apr 28, 2022
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.

2 participants