Skip to content

Commit a1dfadc

Browse files
authored
Fixed broken/outdated documentation URLs (#2017)
Co-authored-by: Juan Leaniz <[email protected]>
1 parent 09f384d commit a1dfadc

File tree

10 files changed

+26
-26
lines changed

10 files changed

+26
-26
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,23 @@ Timesketch is an open-source tool for collaborative forensic timeline analysis.
2727
## Getting started
2828

2929
#### Installation
30-
* [Install Timesketch](docs/getting-started/install.md)
30+
* [Install Timesketch](docs/guides/admin/install.md)
3131

3232
#### Adding timelines
33-
* [Upload data](docs/getting-started/upload-data.md)
33+
* [Upload data](docs/guides/user/import-from-json-csv.md)
3434

3535
#### Using Timesketch
36-
* [Users guide](docs/learn/basic-concepts.md)
36+
* [Users guide](docs/guides/user/basic-concepts.md)
3737

3838
#### Adding a Notebook Container
39-
* [Installation](docs/learn/notebook.md)
39+
* [Installation](docs/guides/user/notebook.md)
4040

4141
## Community
4242
* [Community guide](docs/community/resources.md)
4343

4444
## Contributing
4545
* [Prerequisites](CONTRIBUTING.md)
46-
* [Developers guide](docs/developers/developer-guide.md)
46+
* [Developers guide](docs/developers/getting-started.md)
4747

4848
---
4949

docs/developers/analyzer-development.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ analyzer_run.py: error: the following arguments are required: PATH_TO_ANALYZER,
3535

3636
You can create your sample data either in CSV or JSONL with the same format
3737
that Timesketch can ingest. To learn more about that visit
38-
[CreateTimelineFromJSONorCSV](/user-guide/create-timeline-from-json-csv/)
38+
[CreateTimelineFromJSONorCSV](/guides/user/import-from-json-csv/)
3939

4040
### use existing sample data
4141

docs/developers/api-upload-data.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Create Timeline From Other Sources
22

33
Not all data comes in a good [CSV or JSONL
4-
format](/user-guide/create-timeline-from-json-csv/) that can be imported
4+
format](/guides/user/import-from-json-csv/) that can be imported
55
directly into Timesketch. Your data may lie in a SQL database, Excel sheet, or
66
even in CSV/JSON but it does not have the correct fields in it. In those cases
77
it might be beneficial to have a separate importer in Timesketch that can deal
@@ -94,7 +94,7 @@ Timestamp What URL Results
9494

9595
Here we have a data frame that we may want to add to our Timesketch instance.
9696
What is missing here are few of the necessary columns, see
97-
[documentation](/user-guide/create-timeline-from-json-csv/). We don't really need to
97+
[documentation](/guides/user/import-from-json-csv/). We don't really need to
9898
add them here, we can do that all in our upload stream. Let's start by
9999
connecting to a Timesketch instance.
100100

docs/developers/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ To test mkdocs locally, run the following in your container:
140140
141141
```shell
142142
! cd /usr/local/src/timesketch
143-
! pip3 install mkdocs mkdocs-material
143+
! pip3 install mkdocs mkdocs-material mkdocs-redirects
144144
! mkdocs serve
145145
```
146146

docs/guides/admin/install.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,4 +138,4 @@ Congratulations, your Timesketch system is operational and ready to use.
138138

139139
## Set up users
140140

141-
After system is set up, look at [here](/docs/sysadmin/tsctl.html) to add users.
141+
After system is set up, look at [here](/guides/admin/admin-cli/) to add users.

docs/guides/getting-started.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ hide:
1010
If you don't have your own Timesketch server yet the first step is to install one.
1111
Follow these instructions to get started:
1212

13-
- [Installing Timesketch](../admin/install/)
13+
- [Installing Timesketch](admin/install.md)
1414

1515
## Uploading your first timeline
1616

1717
When you have a Timesketch server setup it is time to upload some data.
1818
Timesketch supports Plaso storage files as well as CSV and JSON formatted files.
1919

20-
- [Uploading timelines to Timesketch](../user/upload-data/)
21-
- [Creating a timeline from JSON or CSV](../user/import-from-json-csv/)
20+
- [Uploading timelines to Timesketch](user/upload-data.md)
21+
- [Creating a timeline from JSON or CSV](user/import-from-json-csv.md)
2222

2323
## Search and explore
2424

2525
When you have timelines uploaded to you server it is time to learn how to search and explore your data.
2626
Take a look there to get started:
2727

28-
- [Search query guide](../user/search-query-guide/)
28+
- [Search query guide](user/search-query-guide.md)

docs/guides/user/import-from-json-csv.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ Unlike JSON files, imports in JSONL format can be streamed from disk, making the
2828

2929
To create a new timeline in Timesketch you need to upload it to the server.
3030

31-
[See here for instructions to do so](/guides/getting-started/upload-data/)
31+
[See here for instructions to do so](/guides/user/upload-data/)

docs/guides/user/upload-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@ appears below the timelines.
6969

7070
The importer client defines an importer library that is used to help with
7171
file or data uploads. This is documented further
72-
[here](/docs/developers/api-upload-data.md)
72+
[here](/developers/api-upload-data/)

mkdocs.yml

+9-9
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ nav:
4646
plugins:
4747
- redirects:
4848
redirect_maps:
49-
"learn/basic-concepts.md": "user-guide/basic-concepts.md"
50-
"learn/sketch-overview.md": "user-guide/sketch-overview.md"
51-
"learn/search-query-guide.md": "user-guide/search-query-guide.md"
52-
"learn/notebook.md": "user-guide/notebook.md"
53-
"learn/create-timeline-from-json-csv.md": "user-guide/create-timeline-from-json-csv.md"
54-
"learn/sigma.md": "user-guide/sigma.md"
55-
"getting-started/install.md": "admin-guide/install.md"
56-
"getting-started/sizing.md": "admin-guide/sizing.md"
57-
"getting-started/upload-data.md": "user-guide/upload-data.md"
49+
"learn/basic-concepts.md": "guides/user/basic-concepts.md"
50+
"learn/sketch-overview.md": "guides/user/sketch-overview.md"
51+
"learn/search-query-guide.md": "guides/user/search-query-guide.md"
52+
"learn/notebook.md": "guides/user/notebook.md"
53+
"learn/create-timeline-from-json-csv.md": "guides/user/import-from-json-csv.md"
54+
"learn/sigma.md": "guides/user/sigma.md"
55+
"getting-started/install.md": "guides/admin/install.md"
56+
"getting-started/sizing.md": "guides/admin/scaling-and-limits.md"
57+
"getting-started/upload-data.md": "guides/user/upload-data.md"
5858

5959
theme:
6060
name: material

timesketch/frontend/src/views/Overview.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ limitations under the License.
120120
Supported formats are Plaso storage file, JSON(L), or a CSV file. If you are uploading a CSV or JSON(L)
121121
file make sure to read the
122122
<a
123-
href="https://github.com/google/timesketch/blob/master/docs/Users-Guide.md#adding-timelines"
123+
href="https://github.com/google/timesketch/blob/master/docs/guides/user/import-from-json-csv.md"
124124
rel="noreferrer"
125125
target="_blank"
126126
>documentation</a

0 commit comments

Comments
 (0)