Skip to content

Commit

Permalink
docs: ✏️ update links for accuracy and improve content across multipl…
Browse files Browse the repository at this point in the history
…e documents

Revised various documents to enhance accuracy and clarity by updating outdated links to archived versions. Changes include updates in Asking Questions.md, Decentralized Autonomous Organizations.md, Decentralized Web.md, Design Docs.md, Making Decisions.md, Open Data.md, Podcasts.md, Teamwork.md, and Writing a Roadmap.md. Additionally, modified link checker arguments in links.yml to improve error handling during checks, ensuring better workflow efficiency.
  • Loading branch information
davidgasquez committed Dec 13, 2024
1 parent 9470ca7 commit 159c3b9
Show file tree
Hide file tree
Showing 11 changed files with 10 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
id: lychee
uses: lycheeverse/lychee-action@v2
with:
args: --accept '200..=204, 429, 403, 500' --suggest .
args: --accept '200..=204, 429, 403, 500' --max-retries 5 --retry-wait-time 5 --suggest .
fail: false

- name: Create Issue From File
Expand Down
2 changes: 1 addition & 1 deletion Asking Questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
3. Be explicit about what you want to achieve in the end and provide as much up-front information as possible to help.
4. Respect other people's [[time]]. Follow up after you get an answer.
- [When asking for help, let the people know what the problem you are trying to solve actually is instead of simply saying your solution and the reader guessing what it is you are actually trying to do](http://xyproblem.info/).
- [Think about the question like a child](https://www.aaronkharris.com/asking-questions).
- [Think about the question like a child](https://web.archive.org/web/20210115231031/https://www.aaronkharris.com/asking-questions).
- The most simple, seemingly silly questions are almost always profound.
- Good questions must come from a sincere desire to learn, rather than as a veiled means of stating your own opinion.
1 change: 0 additions & 1 deletion Decentralized Autonomous Organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,5 @@
- [Snapshot](https://snapshot.org/#/).
- [SourceCred](https://sourcecred.io/docs).
- [DaoHaus](https://daohaus.club/).
- [Coordination Party](https://coordination.party/).
- [CoordinApe](https://coordinape.com/).
- [GitCoin](https://gitcoin.co/).
2 changes: 0 additions & 2 deletions Decentralized Web.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
- [Trello](https://dework.xyz/)
- [Notion](https://www.clarity.so/)
- [Medium](https://mirror.xyz/dashboard)
- [Search](https://slate.host/)
- [Imgur](https://www.pinata.cloud/)
- [Netlify](https://fleek.co/)
- [Firebase](https://textile.io)
Expand Down Expand Up @@ -95,7 +94,6 @@ There is an emerging landscape of [Data and Blockchain](https://www.primodata.or
### Bounty Based Collaboration

- [Bounties Network](https://bounties.network/) - Find freelancers and bounty programs for any task paid in any token on Ethereum.
- [Open Bounty](https://openbounty.status.im/) - Bounty-based collaboration tool that plugs right into GitHub.
- [Gitcoin](https://gitcoin.co/) - The easiest way to leverage the open source community to incentivize or monetize work.
- [Inmunefy](https://immunefi.com/) - Web3's leading bug bounty platform, protecting $100 billion in user funds.
- [DAOexchange](https://daoexchange.app/). Cross-DAO bounty board.
Expand Down
2 changes: 1 addition & 1 deletion Design Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- Short specs are more likely to be read. The purpose of a spec is to briefly communicate the "why", "what" and "how" of the project to the rest of the team. Ideally these short documents force teams to scope out work so priorities are clear and teams avoid building the wrong thing.
- [The longer your document is, the more likely people will only read the comments and not the body.](https://twitter.com/hamiltonulmer/status/1562817324184440832)
- A tech spec forces you to think through complicated issues and to get everyone on the same page. This helps to avoid wasting time on dead-end solutions or building the wrong thing.
- It's hard to make technical decisions while remote. [Build a Proposal Culture](https://hamiltonulmer.com/writing/building-a-proposal-culture) to enable effective distributed technical decision making via [[Writing]] and collecting [[Feedback]] on a written document in an inclusive, async-friendly way.
- It's hard to make technical decisions while remote. [Build a Proposal Culture](https://web.archive.org/web/20220925011031/https://www.hamiltonulmer.com/writing/building-a-proposal-culture) to enable effective distributed technical decision making via [[Writing]] and collecting [[Feedback]] on a written document in an inclusive, async-friendly way.
- Even if no one else reads them, they force you to clarify my thinking before you start the (more expensive) process of implementation.
- Design docs fulfill the following functions in the software development life-cycle:
- Early identification of design issues when making changes is still cheap.
Expand Down
2 changes: 1 addition & 1 deletion Making Decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Decision making is the process we use to identify and choose alternatives, produ
- If you're in between two decisions, don't half-ass both of them! Do one 100%, then do the other 100%.
- People reason more wisely about other people's problems than about their own.
- When you share something, add the level of confidence you have on it.
- [Understand your personal stance on the trade-off of compromise versus purity](https://vitalik.ca/general/2020/11/08/concave.html). Given a choice between two alternatives, often both expressed as deep principled philosophies, do you naturally gravitate toward the idea that one of the two paths should be correct and we should stick to it, or do you prefer to find a way in the middle between the two extremes?
- [Understand your personal stance on the trade-off of compromise versus purity](https://vitalik.eth.limo/general/2020/11/08/concave.html). Given a choice between two alternatives, often both expressed as deep principled philosophies, do you naturally gravitate toward the idea that one of the two paths should be correct and we should stick to it, or do you prefer to find a way in the middle between the two extremes?
- [It's often not _how much force_ you can bring to bear, so much as whether you can apply that force _effectively_](https://www.lesswrong.com/posts/rQKstXH8ZMAdN5iqD/concentration-of-force).

![schema](https://miro.medium.com/max/700/1*9H9letDTBO0IvuGbYN4x6A.png)
Expand Down
2 changes: 1 addition & 1 deletion Open Data.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ I use it as a generic term to refero to data and content that can be freely used

### Data Package Managers

- [Qri](https://qri.io/). An evolution of the classical open portals that added [[Decentralized Protocols]] (IPFS) and computing on top of the data. Sadly, [it came to an end early in 2022](https://qri.io/winding_down).
- [Qri](https://web.archive.org/web/20240413160218/https://qri.io/). An evolution of the classical open portals that added [[Decentralized Protocols]] (IPFS) and computing on top of the data. Sadly, [it came to an end early in 2022](https://qri.io/winding_down).
- [Datalad](https://www.datalad.org/). [Extended to IPFS](https://kinshukk.github.io/posts/gsoc-summary-and-future-thoughts/)
- Is a [great tool](https://archive.fosdem.org/2020/schedule/event/open_research_datalad/) and uses Git Annex (distributed binary object tracking layer on top of git).
- Complicated to wrap your head around. Lots of different commands and concepts. On the other hand, it's very powerful and flexible. Git Annex is complex but powerful and flexible.
Expand Down
2 changes: 1 addition & 1 deletion Podcasts.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ You can explore all the podcast I'm subscribed to in [my PocketCast list](https:
- [Mindscape](https://www.preposterousuniverse.com/podcast/). Conversations with the world's most interesting thinkers. Science, society, philosophy, culture, arts, and ideas.
- Spanish.
- [Fall of Civilizations](https://fallofcivilizationspodcast.com/). A podcast that explores the collapse of different societies through history.
- [Gabinete de Curiosidades](https://www.gabinetepodcast.com/).
- [Gabinete de Curiosidades](https://web.archive.org/web/20240528141801/https://www.gabinetepodcast.com/).
- [Kaizen](https://www.jaimerodriguezdesantiago.com/).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Personal bits of living knowledge, open for everyone.

- 🛠️ Explore [this Handbook on GitHub](https://github.com/davidgasquez/handbook). Send a [Pull Request](https://github.com/davidgasquez/handbook/pulls) or [fill an issue](https://github.com/davidgasquez/handbok/issues) if you have any feedback!
- 🛠️ Explore [this Handbook on GitHub](https://github.com/davidgasquez/handbook). Send a [Pull Request](https://github.com/davidgasquez/handbook/pulls) or [fill an issue](https://github.com/davidgasquez/handbook/issues) if you have any feedback!
- 🗺️ Explore any topic you find interesting on the left sidebar.
- 📣 [Reach out](https://davidgasquez.com/) if you want to chat!

Expand Down
4 changes: 2 additions & 2 deletions Teamwork.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
- Automated code formatting.
- Templates for new projects and components.
- Mechanisms for creating test data.
- Invest in [thoughtful logging](https://www.16elt.com/2023/01/06/logging-practices-I-follow/a).
- Invest in [thoughtful logging](https://www.16elt.com/2023/01/06/logging-practices-I-follow/).
- Create a [[Company Handbooks|handbook]] to store your [[Company Knowledge Management|company knowledge]]. Document:
- [[Processes]]. Status updates, [[Design Docs]], [on-boarding docs/scripts](https://about.gitlab.com/blog/2020/02/10/lessons-learned-as-data-team-manager/), [[Checklist]], ...
- Decisions. Context and rationale can be documented in a durable location.
Expand All @@ -28,7 +28,7 @@
- Responsibilities. Things that aren't your fault can still be your responsibility. If something is everyone's job, it's no one's job.
- Defaults. Each thing should have a place by default, docs, issues, ...
- Aim to be a completely autonomous team. Everyone should feel empower to make decisions. Those who are responsible for something must have the means and context to effect it. You build it, you run it! **The company strategy guides the team, it doesn't tell it what to do.
- [A team's ability to operate autonomously relies on alignment, which is strengthened by context](https://macroapp.io/blog/the-context-warehouse).
- [A team's ability to operate autonomously relies on alignment, which is strengthened by context](https://web.archive.org/web/20230605055308/https://macroapp.io/blog/the-context-warehouse).
- You can also have no durable cross-functional teams. Teams assemble around a project and disperse once the project is done.
- Run [Automated Check-ins](https://basecamp.com/features/checkins) to share things explicitly. What are people working on, what are they planning to work on next, ...
- The right way to promote people is to give them [meaningful and clear goals](https://youtu.be/oIMvMb5wVO4) for the organization and promote them if they hit the goals.
Expand Down
2 changes: 1 addition & 1 deletion Writing a Roadmap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Writing a Roadmap

[Setting direction is one of the most important things you'll do when building a product and company. A clear direction aligns everyone to work toward the same goals](https://linear.app/method/roadmap). It helps individuals make daily decisions, teams prioritize projects and all members of your organization feel motivated toward a shared purpose. Without direction, it's harder to work together, know what to focus on and make meaningful progress.
[Setting direction is one of the most important things you'll do when building a product and company. A clear direction aligns everyone to work toward the same goals](https://web.archive.org/web/20240423211458/https://linear.app/method/roadmap). It helps individuals make daily decisions, teams prioritize projects and all members of your organization feel motivated toward a shared purpose. Without direction, it's harder to work together, know what to focus on and make meaningful progress.

Best practices to follow when building and managing a roadmap:

Expand Down

0 comments on commit 159c3b9

Please sign in to comment.