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

KOP Item resources #151

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

benjamin-antupit
Copy link
Contributor

@benjamin-antupit benjamin-antupit commented Jul 23, 2019

Copied from #25.

I would appreciate any thoughts on @firecrafty's original questions:

Feedback on how to organize this/where to put things would be great, I thought putting them in their own large section would be the right move but I'm not sure anymore as I don't want the sidebar to get too cluttered.

  • vmx-pi
  • Mechanical
  • motors
  • pneumatics
  • robot quick build (put in benchtop section?)
  • sensing (combine with @Oblarg's sensors section?)
  • software
  • wiring/connections
  • other

Edit: I'll be away from the internet for two weeks (back on August 11th) and I plan to continue working on this PR when I return.

@benjamin-antupit
Copy link
Contributor Author

@Daltz333 Should kop-item-resources move from docs/hardware/kop-item-resources to docs/kop-item-resources?

@Daltz333
Copy link
Member

Definitely keep it in hardware

@benjamin-antupit
Copy link
Contributor Author

Can someone help me figure out why the build is failing? Is it an Azure thing or something to do with this PR?

@Daltz333
Copy link
Member

Some mathematical symbol that is included that the PDF generation doesn't like. Try to use the UTF versions of symbols and minimize latex usage

@benjamin-antupit benjamin-antupit changed the title [WIP] KOP Item resources KOP Item resources Jul 28, 2019
Copy link
Member

@AustinShalit AustinShalit left a comment

Choose a reason for hiding this comment

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

The links should be updated to use HTTPS.

@Daltz333 Do you have any ideas about how to make this page look cleaner. Right now I feel like there is a wall of links where on ScreenSteps the download links stood out.

For comparison: https://wpilib.screenstepslive.com/s/currentCS/m/kop/l/696729-multisim-ultiboard-and-statechart-module

@AustinShalit
Copy link
Member

(This page is the Multisim page, not the whole PR)

@Daltz333
Copy link
Member

Daltz333 commented Jul 28, 2019

The Kop should be a section under hardware. Adding each individual (hardware related) section to the main toc makes the sidebar substantially longer with little gain. Looking at things further, I see no need to even call it "Kit of Parts" (this will still make the sidebar longer, but with a benefit at least). My thoughts are, with your current organization scheme, that things can then be added to each section. (motors to motors).

Copy link
Member

@Daltz333 Daltz333 left a comment

Choose a reason for hiding this comment

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

Absolutely fantastic! As always thank you for your work!

This is quite a huge change so will likely take several rounds of revisions. I love the structure and use the download directives.

source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/mechanical/linear-bushings.rst Outdated Show resolved Hide resolved
source/docs/hardware/mechanical/linear-bushings.rst Outdated Show resolved Hide resolved
source/docs/hardware/mechanical/linear-bushings.rst Outdated Show resolved Hide resolved
source/docs/hardware/motors/bosch-seat-motor.rst Outdated Show resolved Hide resolved
source/docs/hardware/motors/nidec-dynamo-bldc.rst Outdated Show resolved Hide resolved
source/docs/hardware/motors/nidec-dynamo-bldc.rst Outdated Show resolved Hide resolved
source/docs/hardware/sensors/jetson-tx1-developer-kit.rst Outdated Show resolved Hide resolved
Copy link
Member

@Daltz333 Daltz333 left a comment

Choose a reason for hiding this comment

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

Remove the .DS_Store file

@benjamin-antupit
Copy link
Contributor Author

@Daltz333 Anything else?

@benjamin-antupit
Copy link
Contributor Author

@AustinShalit Please review.

Daltz333
Daltz333 previously approved these changes Sep 3, 2019
Copy link
Member

@Daltz333 Daltz333 left a comment

Choose a reason for hiding this comment

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

Thanks for the work :)

source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/mechanical/linear-bushings.rst Outdated Show resolved Hide resolved
source/docs/hardware/mechanical/linear-bushings.rst Outdated Show resolved Hide resolved
source/docs/hardware/mechanical/linear-bushings.rst Outdated Show resolved Hide resolved
@benjamin-antupit benjamin-antupit dismissed stale reviews from Daltz333 via 48669e8 September 3, 2019 16:46
@AustinShalit
Copy link
Member

@Daltz333 How do you feel about moving the content located inside of the zip files out of the zip files?

@Daltz333
Copy link
Member

Daltz333 commented Sep 8, 2019

We're getting those zip files moved to other locations, and then this should be ready for merge.

@benjamin-antupit
Copy link
Contributor Author

Can someone rebuild this PR?

@Daltz333
Copy link
Member

The pull-request failing is accurate, kauai-kabs with the sub-domain vmx-pi no longer exists (the http version will redirect, and the https will fail with an invalid certification error).

Copy link
Member

@Daltz333 Daltz333 left a comment

Choose a reason for hiding this comment

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

Links need to be fixed, and then the zip files need to reference https://first.wpi.edu/FRC/roborio/Docs/ instead of being local.

Copy link
Member

@Daltz333 Daltz333 left a comment

Choose a reason for hiding this comment

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

This is just a partial review of the links that needs fixing. There are still more.

source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/control/vmx-pi.rst Outdated Show resolved Hide resolved
source/docs/hardware/mechanical/linear-bushings.rst Outdated Show resolved Hide resolved
@Daltz333
Copy link
Member

Daltz333 commented Sep 14, 2019

The kauai labs webpage keeps going offline. I'll be contacting them about this. However, I don't see any issues with the links any more. @AustinShalit would you mind retriggering this build?

@Daltz333
Copy link
Member

It seems to have succeeded. Would you mind fixing the last couple of redirects?

@benjamin-antupit
Copy link
Contributor Author

I think I fixed all the redirects and added links to https://first.wpi.edu/FRC/roborio/Docs/ where applicable. Could you also upload L4TMultimediaAPIReference.zip to https://first.wpi.edu/FRC/roborio/Docs/? It belongs in docs/hardware/sensors/jetson-tx1-developer-kit.rst line 65.

@Daltz333
Copy link
Member

Was that link previously hosted on ScreenSteps as well?

@benjamin-antupit
Copy link
Contributor Author

The file was linked on NVIDIA's website. The link label is "Multimedia Guide" and you can find it under the Documentation heading on ScreenSteps.

@benjamin-antupit
Copy link
Contributor Author

benjamin-antupit commented Oct 5, 2019

I was just reviewing the changes this PR makes to the navigation sidebar. Would it be better to move all the Kit of Parts resources to one super-folder which has an index for all the KOP sub-categories (Sensors from the KOP, Control, Mechanical, Motors, Pneumatics, Robot Quick Build, Wiring & Connections and Other) to avoid adding too much to the navigation bar?

@Daltz333
Copy link
Member

Daltz333 commented Oct 6, 2019

@yellowjaguar5 now with the revision, I agree.

source/index.rst Show resolved Hide resolved
source/docs/hardware/kit-of-parts/control/vmx-pi.rst Outdated Show resolved Hide resolved
@benjamin-antupit
Copy link
Contributor Author

One of the LintCheck builds failed, but not the other one. Huh.

@modelmat
Copy link
Contributor

modelmat commented Oct 29, 2019

Is this all fine to merge then?

Will probably have merge conflicts though.

@benjamin-antupit
Copy link
Contributor Author

I want to add source files for the illustrations I created per @Daltz333's comment in #200 and then I think it will be mergeable.
It would be great if this PR could get a review, though.

@Kevin-OConnor
Copy link
Contributor

We are planning on adding a lot more KoP content this season and the people doing it are more comfortable doing so in Screensteps than in RTD so our current plan is to leave all KoP content on Screensteps for this season.

@Daltz333
Copy link
Member

@yellowjaguar5 Mind updating this for the current season?

@benjamin-antupit
Copy link
Contributor Author

Sure, but before I put too many hours into it, I want to make sure FIRST is ready to move this content to WPILib docs. @Kevin-OConnor, is that correct? If so, I have time this weekend to start (and hopefully finish) it.

@benjamin-antupit
Copy link
Contributor Author

This page on ScreenSteps Live has 4 downloadable files linked. Should I include the files themselves under kit-of-parts/motors/files and add download links or link to the ScreenSteps Live download links?

@Daltz333
Copy link
Member

The files are now located at https://first.wpi.edu/FRC/roborio/Docs/ with each of their original file names. EG: https://first.wpi.edu/FRC/roborio/Docs/2020-02-12_JE-PLG-149_R2.pdf

@benjamin-antupit
Copy link
Contributor Author

I added the page for the Johnson Electric PLG Motor. As far as I can tell, nothing else was added to ScreenSteps KOP Documentation this season. Is that correct?

@benjamin-antupit
Copy link
Contributor Author

@Daltz333 Could you review this?

@Daltz333
Copy link
Member

It looks fine as far as I can tell. However @Kevin-OConnor needs to do a review.

@Daltz333 Daltz333 force-pushed the kop-resources branch 2 times, most recently from 76bd8b2 to 0cc20be Compare September 7, 2020 16:52
@Daltz333
Copy link
Member

Daltz333 commented Oct 27, 2021

This is still planned, but there are some hurdles that need to get done on the FIRST side of things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: New Article Waiting On: FIRST Waiting on something from FIRST
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants