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

blog: Blog for working directory feature #77

Merged
merged 4 commits into from
Dec 12, 2023

Conversation

abhijeetSaroha
Copy link
Contributor

@abhijeetSaroha abhijeetSaroha commented Dec 9, 2023

@xmnlab Please review the blog

@xmnlab
Copy link
Member

xmnlab commented Dec 11, 2023

metadata:

---
title: "Efficent Workflows with Makim's Working Directory"
slug: "makim-efficient-workflows-with-makims-working-directory"
date: 2023-12-10
authors: ["Abhijeet Saroha"]
tags: ["makim", "osl", "working-directory"]
categories: ["devops", "automation", "python"]
description: |
  In this blog post, we'll explore the Working Directory feature, understand 
  its syntax, and witness its power in action through real-world examples. Whether
  you're a Makim veteran or a newcomer, this feature is designed to make your
  command-line experience more flexible and tailored to your project's needs.
  Let's dive into the details and unleash the potential of Makim's Working Directory
  feature!
thumbnail: "/header.jpg"
template: "blog-post.html"
---

@xmnlab
Copy link
Member

xmnlab commented Dec 12, 2023

@abhijeetSaroha , please rebase your branch on top of the upstream/main.

additionally, you need to execute some steps locally

  • recreate the conda environment
  • activate it again
  • rename your ipynb file to indx.ipynb
  • change the header image to something that could be used for a automation tool (makim doesn't have any image yet)
  • run makim pages.build (it will generate and index.md and some images to index_files)
  • add these new files to git
  • commit and push your changes

let me know if you have any questions

@abhijeetSaroha
Copy link
Contributor Author

@xmnlab , do as you said, can you please check it further?

"slug: \"makim-efficient-workflows-with-makims-working-directory\"\n",
"date: 2023-12-10\n",
"authors: [\"Abhijeet Saroha\"]\n",
"tags: [\"makim\", \"osl\", \"working-directory\"]\n",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"tags: [\"makim\", \"osl\", \"working-directory\"]\n",
"tags: [\"makim\", \"automation\", \"working-directory\", \"devops\", \"open-source\"]\n",

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

Copy link
Member

@xmnlab xmnlab left a comment

Choose a reason for hiding this comment

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

text looks good to me. thanks!
just add some notes here
thanks for working on that!

"id": "edeab9cc-5fa2-44ac-b1fb-5570c5f5753c",
"metadata": {},
"source": [
"multi_language_project/\n",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"multi_language_project/\n",
"```\n",
"multi_language_project/\n",

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

" ├── react/\n",
" │ └── src/\n",
" └── vue/\n",
" └── src/\n"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
" └── src/\n"
" └── src/\n"
" ```\n"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

@xmnlab
Copy link
Member

xmnlab commented Dec 12, 2023

as I mentioned inline in the jupyter notebook .. please add the triple backticks in order to fix this issue:

Screenshot_20231212_112620

@xmnlab
Copy link
Member

xmnlab commented Dec 12, 2023

after applying the changes, you need to rebuild it again locally before creating a new commit:

$ makim pages.build

@xmnlab
Copy link
Member

xmnlab commented Dec 12, 2023

@abhijeetSaroha , question: are that image free to use? we need to be careful with copyrights

@abhijeetSaroha
Copy link
Contributor Author

@abhijeetSaroha , question: are that image free to use? we need to be careful with copyrights

Don't sure about that image, but now I have changed the image which is free. So, I don't think that there should be any issue in using this new image.

Copy link
Member

@xmnlab xmnlab left a comment

Choose a reason for hiding this comment

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

LGTM! thanks!

@xmnlab xmnlab merged commit 8e2c45b into OpenScienceLabs:main Dec 12, 2023
1 check passed
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