GithubHelp home page GithubHelp logo

openbeta / docs.openbeta.io Goto Github PK

View Code? Open in Web Editor NEW
4.0 4.0 8.0 10.93 MB

OpenBeta official documentation

Home Page: https://docs.openbeta.io

JavaScript 61.58% CSS 38.42%
climbing climbing-api rock

docs.openbeta.io's People

Contributors

actuallyyun avatar amandril avatar clintonlunn avatar cocoisbuggy avatar draykhlin avatar robbyriley15 avatar vnugent avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs.openbeta.io's Issues

Change "open-tacos" to "climb database" or climbing route catalog

Background

open-tacos is the code name for the coding project that powers our main website https://openbeta.io

When the project first started, the website is also called "open-tacos" (old domain: tacos.openbeta.io).

Proposal

To simplify our brand messaging, only use OpenBeta or the "climb database" or the climb route catalog. Retire "open tacos" in any public facing documentation.

When a coder wants to learn more contributing code, we can point them to open-tacos repository on GitHub. Other than that we should only use OpenBeta to refer to our main project, the website, or the climb database or the climbing catalog.

On the documentation page "clicking the home button" does not working !

Steps to Reproduce

link to the page (https://docs.openbeta.io/)

Screenshots

(https://github.com/OpenBeta/open-tacos/assets/76779072/746cbfcd-8382-4096-a84d-e9ca7c7b9935)

Expected Behavior

you can also check how it should be work on https://www.summitpost.org/phpBB3/

  1. Navigation to the Home Page: The website's server processes your click and redirects your browser to the designated home page URL. This action takes you back to the starting or main page of the website.

  2. Resetting the Browsing Context: Clicking the home button resets the browsing context, meaning any temporary changes or states that occurred on the previous page (e.g., scrolled position, form input, filters, etc.) are typically reset to their default values on the home page.

  3. Page Reload or Cache Usage: Depending on the website's design, clicking the home button may trigger a page reload, ensuring that you see the most up-to-date version of the home page. However, if the home page has been cached in your browser, it may load from the cache instead, providing a faster loading experience.

Current Behavior

Clicking the home button not working right now!

Browser & version

Google Chrome Version 113.0.5672.93

Operating system

Windows 11

Update how to contribute document

What to achieve:

  • use updated info
  • make it clear and actionable

Proposed change:

Whether you have a little time to spare or are ready to dive in deep, we have various levels of involvement to suit your availability and commitment. Choose the level that best fits your preferences and make a meaningful impact on the project.

Level 0: Start Using Open Tacos

If you have limited time but still want to contribute, you can help by simply start using open tacos.

  1. Register an account, browse climbing data, add climbing data if you can't find what you are looking for, and share your climbing photos with the community.
  2. You could also support us by following our social media accounts, and tagging us when you post something about open beta.
  3. Give us feedback. How do you like it? What features would you like to have? Help us improve the project by reporting any bugs, usability concerns, or feature requests you come across. You can do so either through our Discord community, or by submitting issues on open tacos.

Level 1: Quick Contributions

If you have a bit more time, you could have a quick contribution in two fields:

No Code

  1. Add climbing data through Open Tacos(for example, your local climbing area.
  2. Contact us about your local climbing organization.
  3. Report issues through our local climbing organization feature if there is one in your region

Code

  1. Pick up an issue: Browse through the list of open issues and find one that matches your skills and interests. Leave a comment expressing your intent to work on it to avoid duplication of effort.
  2. Submit pull requests: Implement bug fixes, add new features, or improve documentation. Make sure to follow the project's coding style and conventions, write tests, and keep the changes concise and focused.

Go to Dev Onboarding to get started.

Level 2: Medium Contributions

If you want to be more involved, consider working on medium-sized contributions. Here are some ways to get started:

No Code

  1. Become Our Regional Ambassador and maintain an area
    tbd (what is Regional Ambassador, responsibilities and how to start)

  2. Help us with UI/UX design, you can pick up a design task from this list. Please go to Design onboarding to get started.

  3. Help us with marketing.

Code

If our current project interests you, consider joining the project!
You can find our current project here. (tbd)

Level 3: Deep Dive and Long-Term Contributions

If you are passionate about the project and want to make significant contributions over an extended period, this level of involvement is for you. Here's how you can make a lasting impact:

No Code

  1. Social media manager
  2. UX/UI designer

Code

How to get involved in this level,tbd

Remember, regardless of the level you choose, collaboration and open communication are vital. Engage with the community, ask questions, and seek feedback when needed.

Thank you for considering contributing to Open Beta We appreciate your support, and we look forward to seeing your contributions!

Useful Resources for contributing:

  • Code of Conduct
  • General Onboarding
  • Dev Onboarding
  • Designer Onboarding
  • Marketing Onboarding

Update or create a current project page

Currently, we have suggested coding project page page. I was thinking of having a page showing info and progress about our current project, for example, the climbing log project, so that new contributors can check it out and get involved.
Info for this could include:

  • Project definition, design
  • Who is involved
  • Project status (done, to-do, backlog)
  • Bi-weekly sprint meeting notes
  • Help needed for this specific project

package-lock.json should be committed

according to this the lock file should probably be committed?

Unless there is something about docusaurus in particular - in which case it should be added to gitignore

Add general onboarding checklist

Current we have two items of the general onboarding checklist

General Checklist
CHECKLIST FOR EVERYONE
Sign up for Discord
Sign up for GitHub

I think we should also add:

  • Deep dive about open beta: what we do, what have we done, what we are doing now.
  • Read the introduction(about, roadmap, current project etc)
  • Read our internal documentation(e.g., meeting memos)
  • Organization workflow(how we communicate )
  • Approval process (what's the process like, timeline)

Organization Workflow

Our workflow involves both unsynchronized communications through GitHub issues, pull requests (PRs), and a Discord channel, as well as regular synchronized meetings. Here's an overview of our organization workflow:

Unsynchronized Communication

GitHub Issues:

  • Use GitHub issues to report bugs, suggest features, or discuss project-related topics.
  • If you'd like to work on the issue, assign yourself.
  • If you are unsure about how to start, you could @ our core dev team members(list here). Alternatively, you could post in our discord channel to get help.

Pull Requests (PRs):

  • Once you know how to start working on the issue, you could fork the project repository and create a branch for your changes.
  • Submit PRs to propose changes, bug fixes, or new features.
  • Request reviews from our core dev team members, engage in PR discussions, respond to feedback, and iterate on the changes based on reviewer comments.

Discord Channel:

  • Join our Discord channel to connect with the community and engage in real-time discussions.
  • If you are stuck, this is a good place to seek help, ask questions, and share ideas or insights related to the project.
  • Coordinate efforts, gather feedback, and collaborate with other contributors.

Synchronized Meetings

We meet bi-weekly to synchronize efforts and provide updates on the project's progress. Check out the current project we are working on and join the meeting if you are interested.

Approval Process

  1. GitHub Issues:
  • Everyone can open an issue and assign themselves to the issue.
  • If you'd like to work on an existing issue, please comment and make sure that no one is working on it to avoid duplicated effort.
  • We recommend you discuss the solutions you have in mind before you start working on it. If you don't know where to start, you should ask for help. Please refer to the organization workflow to start a conversation.
  1. Pull Requests:
  • You could assign our core dev team members to review your PR.
  • During the review process, you might get some feedback and suggestions.
  1. Approval and Merging
    Once your changes have been reviewed and you've incorporated the feedback, one of our project maintainers will merge your PR. (@vnugent not sure if this is the workflow we have now, please advise)

Dev bootcamp

Task list
One task for a new dev to open a PR, for example, edit this test file.
Run test
A screenshot of their changes(change the color of the test page)
Vercel prebuilds automation.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.