Okay. Cool.
So
all right.
So today we're going to quickly talk about
relative paths in the handbook, how to go about and how do they work and so forth.
So I think the easiest thing is actually
for me to just speak from a text document point of view.
I'm going to share my screen quickly.
And then we can talk through a couple of examples to show what happens.
Alright. So
let's assume, for instance, in our repo, we've got a handbook folder.
And then in there things like engineering.
And in there you'll use my.
Org developer insights.
We also have handbook and people ops
with pages in there. And so on.
Now in terms of creating links to other
pages, say, for instance, I'm on on this page here.
And I want to reference a maybe even just
let's do
company.
That is.
And let's say I want to make a link from this page to this page.
Now the first thing to note is they're not in the same place.
They're in different structures.
And so I can't just say I
so on this page, for instance, say I want to link to the values in maekdown.
I can just say values.md
because when the program that reads
this markup interprets links, it always takes it from where you currently are at.
So when it's like on this page
and it sees something like this, it expects there to be a page called Values.md
in that same path.
But there isn't.
And that's not the one we want.
So we need to tell it, how do we get here?
This is where the dot dot notation comes in.
So whenever you say
../ It says, go one directory further up in the path.
So we're here.
And if we go .. It means it moves us here.
And so now all of a sudden it's basically
saying, okay, now it's looking for values.md here.
But that's not where we want it.
So we go we go another dot dot.
And now it's saying, okay there.
But that's not where we want to be.
We now need to go forward.
So in a company, values.
And now it's basically saying, okay,
from this page, go to two directories up in the tree,
then going to company and then go into values.
So if we go two directories up,
it gets us into handbook, then go to Company and then go to Values.
And that's how you make the connection there.
So think of it.
And if I take these two examples and show them as a tree, we've got handbook.
Then we've got a company and we've got
values.md and here we have engineering
at her
insights.
And we've got the next index.
So
this is the folder tree structure.
So if we look at this again, it says, Go to up.
I'm here. Then I'm going to up,
which means I'm in handbook and then it says go to Company.
So they're going here and into values.
So this notation is literally just telling
the the program that's interpreting this code to say from your current point,
where you're at in the directory structure, go with directory up,
go another one up, then go to Company and the into values.
And so you're basically just navigating
to the path of where you want to link to something.
Does that make sense to you? Totally.
Yes. Thank you.
Very clear.
So
great. Well, it's clear now, but it's
it's not the most intuiting unless you've used this before.
And a lot of engineers will use this kind of path notation in their code and stuff.
So it's very natural to them.
But if you haven't used this before, it's not always a natural.
You don't know why it's like that.
What are these dots and flashes?
It doesn't take a and I know sometimes we have this same .md name index is in almost
every handbook page, so I didn't know how I would name it.
Now I know that mean go back go to. Yeah.
So now it makes sense.
It's easier to paste the link the URL link.
But now I understand why.
And also if you have an absolute URL to the full link, if that changes,
it's much more difficult to change themes around.
If you have relative URLs,
you can switch things easier around like that as well.
Also, it's valuable in terms of
if you're in GitHub and you view the markdown rendered version of the page,
you can click on that path, and it will take you to that values.
That in file because it can interpret the path in the folder structure for you.
So yeah, there's some small things it's just always better to.
And the problem is, for instance, if you go about.sourcegraph.com/handbook .
What if we change the handbook to handbook.sourcegraph.com
now we need to go change it.
If we have read it the URLs, we never have to change anything if we change it.
If we change, what if we change the place the pages
in so we migrate, for instance, this page from people ops to talent.
Yes.
You would still need to go and update the paths And update the paths.
That point to it. Yes, it would need to be updated.
Okay. Perfect.
Alright. Thank you.