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
Check all links in docs and make them more accessible #424
Comments
Hello, I'm interested in this and wonder if I may. If I'm to be allowed, I have some questions on working on the issue
|
Hi @kaestro That would be fantastic, thank you for offering a contribution. Here are a few answers:
If you prefer to focus just on Task 1, that would be wonderful, and the other two tasks can wait, or you can tackle all. Up to you! It's wonderful that you've offered to contribute. |
Thank you for all the replies and welcome. It helped a lot I'll try to catch up on the Task 1 first. If you don't mind, for it's my first time trying to contribute on open-source, I might take some time to start on working itself. It's because I've only used github as contributor only, although the guide page is pretty much helpful. Also I'm not yet experienced with hatch. Would it be okay for me to take some time? If it's okay, I want to start working on it from today p.s.) Also, my English is not that okay for I'm not using it as first language. |
Hi @kaestro Welcome to the project. Please take as long as you like to work on this. It's late here in the UK but I'll write you some basic instructions tomorrow to use Hatch and docs. |
sorry for the late contact. It's 6:45 am in Korea right now. Thank you for the support, and have a good night! |
Any problems at this stage, please let us know! Then you can modify the Good luck, and let us know how you get on. |
Thank you for all the supports. This project's CI is absolutely amazing, I'm really astonished. Right now it's up and running. BTW, do you want me to request pr after I feel like finished the task 1, or do you want me to request pr step by step? I wonder if there's some style suggested. If there's none, I prefer the second |
Great news! We are really pleased you've found it easy to get up and running 👯 I think it would make sense, as it's your first time, to request a PR review after task 1, just so you can be sure of the end-to-end process. It's all very straightforward for docs but you'll need to run Thanks again! |
It's me who's really thankful of. Before I get started, I've found some questions hope I'm not bothering you too much to answer. Right now, I'm reading Explore vizro page and having confusions on how to apply the documentation rule the second and third part of documentation says that
So, Q1 should I be removing the duplicates on this page? Or do you want me to leave the duplicates for APIs like this page. Q2 Do you want me to add some links for those API links which can help users back to where their narrative content? Q3 Do you have any commit conventions? |
Good spot! But please leave that for now in favour of working on the task for this issue, which is to make the link text accessible and descriptive. Reason being that I am yet to edit some pages that will make revisions such as the ones you suggest here.
Likewise, you can leave those for now, but thank you for offering.
I wouldn't worry too much about individual commits. I tend to group them together and commit small chunks for a particular page, feature or task, rather than all at once or random collection. So for example, I might commit changes to the nav of the docs in one and typo fixes in another, even though it's all the same PR to add a new page. Don't sweat it too much! |
Questions. Is it ok for me to remove some duplicate links that I think it would make better readability? for example, what I'm trying to change is from this into this |
Also, I've made some changes on explore vizro page and want to check whether this is what this issue wanted, and I'm following the style guide correctly. Once again, thank you for all your supports and have a nice week |
Hi @kaestro all your edits look great to me, thank you. 🌟 |
I think I'm about 50~60% done for vizro core and wonder if I might send a pull request to get reviews on whether I'm doing it properly. May I? |
Hi @kaestro Please do make a PR when you are ready! I'm out of office until Wednesday 8th May but one of the team can help if you need it, and may be able to offer you a review, but I will otherwise pick up on my return. |
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: 김태홍 <didme07@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Co-authored-by: Li Nguyen <90609403+huong-li-nguyen@users.noreply.github.com>
Guidelines for links are as follows:
Task (1) Fix all links
Before we have perfection, we need to run through all the docs pages and fix issues like this one #422 (comment) where they arise.
Task (2) Set up style checking for future content
One way to enforce this ongoing would be to use Vale. I've asked how to do this:
errata-ai/vale#807
Task (3) Add external link checking (if not already running) to CI.
We already have this for internal links in that we build with
--strict
but need to have something check links to Dash etc as Kedro does.This ticket doesn't need technical writing skills nor does it need Vale knowledge. Good first issue for a new contributor!
The text was updated successfully, but these errors were encountered: