Skip to content

Fix primary color. Propose git URL for repo #1

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

Merged
merged 1 commit into from
Mar 16, 2023
Merged

Conversation

cachafla
Copy link
Contributor

Couple of minor changes:

  • Use actual primary color code
  • I suggest we use the SSH (git) based URL for cloning

About cloning the validmind-python repo

make get-source requires that we setup some Python dependencies for generating the docs. I manually installed these dependencies in order to get this running as described here:

You need:

- Sphinx `docutils`
- Supporting tools: `sphinx_markdown_builder`, `myst_parser`, `dython`, `pandas_profiling`, and `shap`

I'm not sure why these dependencies are required for generating docs, I need to look into that. In any case, I'm almost leaning to propose that we setup poetry on this repo so we're ready to generate docs after cloning the repo. This will also make it easier for us to implement the CI/CD component for it (and even leverage GitHub caching).

I'll think about this in terms of preparation for our CI/CD and have a proposed solution for next week.

@cachafla cachafla requested a review from nrichers March 16, 2023 00:19
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM! I pulled down your PR and gave it a quick test. Thank you for updating the Makefile to use SSH with GitHub and for fixing the primary color (I'd grabbed that off a screenshot from our main website originally). :shipit:

I'm not sure why these dependencies are required for generating docs, I need to look into that. In any case, I'm almost leaning to propose that we setup poetry on this repo so we're ready to generate docs after cloning the repo.

When I tested your make markdown, I had to install a bunch of things with pip to get it to work and later just went through my history to grab the details. For sure, let's chat about better ways of handling things when we tackle the CI/CD ticket in the coming sprint. (My Makefile for the docs site does currently generate Markdown for the Python docs, but it basically just calls your make markdown after cloning.) 👍

@cachafla cachafla merged commit 7a70b40 into main Mar 16, 2023
@cachafla cachafla deleted the change-primary-color branch March 16, 2023 18:33
validbeck added a commit that referenced this pull request Jun 13, 2024
validbeck added a commit that referenced this pull request Jun 21, 2024
* Added a vm_login variable for instructions to reference

* Changed #1 login to the variable

* Adjusted the hacky CSS on customize-documentation-templates.qmd

* Adjusted some guides that were missing the #1 login step

* Final pass of the login variable

* Manually fixed merge conflicts & login variables in includes files

* 1st pass of extraneous links within instructions

* 2nd pass of extraneous instruction links & quick style tweaks

* Last pass extraneous links/margin learn mores until roles/permissions r done

* Reviewed bolding of links & retooled About landing page

* Penultimate-pass of margin links

* Added margin content to style guide

* Quick adjust to collaborate with others

* Quick edit to the summaries for automation & risk management

* Removed the bullet points from margin lists
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