Skip to content

Commit

Permalink
Fixed broken/outdated documentation URLs (#2017)
Browse files Browse the repository at this point in the history
Co-authored-by: Juan Leaniz <leaniz@google.com>
  • Loading branch information
jleaniz and jleaniz committed Nov 9, 2021
1 parent 09f384d commit a1dfadc
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 26 deletions.
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -27,23 +27,23 @@ Timesketch is an open-source tool for collaborative forensic timeline analysis.
## Getting started

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

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

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

#### Adding a Notebook Container
* [Installation](docs/learn/notebook.md)
* [Installation](docs/guides/user/notebook.md)

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

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

---

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/analyzer-development.md
Expand Up @@ -35,7 +35,7 @@ analyzer_run.py: error: the following arguments are required: PATH_TO_ANALYZER,

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

### use existing sample data

Expand Down
4 changes: 2 additions & 2 deletions docs/developers/api-upload-data.md
@@ -1,7 +1,7 @@
# Create Timeline From Other Sources

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/getting-started.md
Expand Up @@ -140,7 +140,7 @@ To test mkdocs locally, run the following in your container:
```shell
! cd /usr/local/src/timesketch
! pip3 install mkdocs mkdocs-material
! pip3 install mkdocs mkdocs-material mkdocs-redirects
! mkdocs serve
```
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/admin/install.md
Expand Up @@ -138,4 +138,4 @@ Congratulations, your Timesketch system is operational and ready to use.

## Set up users

After system is set up, look at [here](/docs/sysadmin/tsctl.html) to add users.
After system is set up, look at [here](/guides/admin/admin-cli/) to add users.
8 changes: 4 additions & 4 deletions docs/guides/getting-started.md
Expand Up @@ -10,19 +10,19 @@ hide:
If you don't have your own Timesketch server yet the first step is to install one.
Follow these instructions to get started:

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

## Uploading your first timeline

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

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

## Search and explore

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

- [Search query guide](../user/search-query-guide/)
- [Search query guide](user/search-query-guide.md)
2 changes: 1 addition & 1 deletion docs/guides/user/import-from-json-csv.md
Expand Up @@ -28,4 +28,4 @@ Unlike JSON files, imports in JSONL format can be streamed from disk, making the

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

[See here for instructions to do so](/guides/getting-started/upload-data/)
[See here for instructions to do so](/guides/user/upload-data/)
2 changes: 1 addition & 1 deletion docs/guides/user/upload-data.md
Expand Up @@ -69,4 +69,4 @@ appears below the timelines.

The importer client defines an importer library that is used to help with
file or data uploads. This is documented further
[here](/docs/developers/api-upload-data.md)
[here](/developers/api-upload-data/)
18 changes: 9 additions & 9 deletions mkdocs.yml
Expand Up @@ -46,15 +46,15 @@ nav:
plugins:
- redirects:
redirect_maps:
"learn/basic-concepts.md": "user-guide/basic-concepts.md"
"learn/sketch-overview.md": "user-guide/sketch-overview.md"
"learn/search-query-guide.md": "user-guide/search-query-guide.md"
"learn/notebook.md": "user-guide/notebook.md"
"learn/create-timeline-from-json-csv.md": "user-guide/create-timeline-from-json-csv.md"
"learn/sigma.md": "user-guide/sigma.md"
"getting-started/install.md": "admin-guide/install.md"
"getting-started/sizing.md": "admin-guide/sizing.md"
"getting-started/upload-data.md": "user-guide/upload-data.md"
"learn/basic-concepts.md": "guides/user/basic-concepts.md"
"learn/sketch-overview.md": "guides/user/sketch-overview.md"
"learn/search-query-guide.md": "guides/user/search-query-guide.md"
"learn/notebook.md": "guides/user/notebook.md"
"learn/create-timeline-from-json-csv.md": "guides/user/import-from-json-csv.md"
"learn/sigma.md": "guides/user/sigma.md"
"getting-started/install.md": "guides/admin/install.md"
"getting-started/sizing.md": "guides/admin/scaling-and-limits.md"
"getting-started/upload-data.md": "guides/user/upload-data.md"

theme:
name: material
Expand Down
2 changes: 1 addition & 1 deletion timesketch/frontend/src/views/Overview.vue
Expand Up @@ -120,7 +120,7 @@ limitations under the License.
Supported formats are Plaso storage file, JSON(L), or a CSV file. If you are uploading a CSV or JSON(L)
file make sure to read the
<a
href="https://github.com/google/timesketch/blob/master/docs/Users-Guide.md#adding-timelines"
href="https://github.com/google/timesketch/blob/master/docs/guides/user/import-from-json-csv.md"
rel="noreferrer"
target="_blank"
>documentation</a
Expand Down

0 comments on commit a1dfadc

Please sign in to comment.